From 95659cdeaef8343d60d0a08846d626f07bdd93cc Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Thu, 29 Feb 2024 12:36:31 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- functions/createVerifiedFetch.html | 2 +- functions/verifiedFetch-1.html | 4 ++-- index.html | 14 ++++++-------- interfaces/CIDDetail.html | 4 ++-- interfaces/CIDDetailError.html | 4 ++-- interfaces/ContentTypeParser.html | 2 +- interfaces/CreateVerifiedFetchInit.html | 4 ++-- interfaces/CreateVerifiedFetchOptions.html | 4 ++-- interfaces/ResourceDetail.html | 4 ++-- interfaces/VerifiedFetch.html | 4 ++-- interfaces/VerifiedFetchInit.html | 2 +- types/BubbledProgressEvents.html | 2 +- types/Resource.html | 2 +- types/VerifiedFetchProgressEvents.html | 2 +- 14 files changed, 26 insertions(+), 28 deletions(-) diff --git a/functions/createVerifiedFetch.html b/functions/createVerifiedFetch.html index 95d3e0ef..d0daffc2 100644 --- a/functions/createVerifiedFetch.html +++ b/functions/createVerifiedFetch.html @@ -1,2 +1,2 @@ createVerifiedFetch | @helia/verified-fetch

Function createVerifiedFetch

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<VerifiedFetch>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/verifiedFetch-1.html b/functions/verifiedFetch-1.html index a8febbc2..cc1940e0 100644 --- a/functions/verifiedFetch-1.html +++ b/functions/verifiedFetch-1.html @@ -1,3 +1,3 @@ -verifiedFetch | @helia/verified-fetch

Function verifiedFetch

Methods

start +verifiedFetch | @helia/verified-fetch

Function verifiedFetch

Methods

start stop -

Methods

start

stop

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Methods

start

stop

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/index.html b/index.html index 68b6bf81..11023f6b 100644 --- a/index.html +++ b/index.html @@ -8,16 +8,14 @@ Discuss codecov CI

-
-

A fetch-like API for obtaining verified & trustless IPFS content on the web

-
-

About

This repo contains a server implementation of the IPFS Delegated Routing V1 HTTP API along with a client that can be used to interact with any compliant server implementation.

+

About

This monorepo contains the @helia/verified-fetch package and its corresponding interop tests.

+

Getting started

See the @helia/verified-fetch package for how to get started with the package including usage examples.

Packages

API Docs

License

Licensed under either of

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/CreateVerifiedFetchInit.html b/interfaces/CreateVerifiedFetchInit.html index 08256b7c..b99217c5 100644 --- a/interfaces/CreateVerifiedFetchInit.html +++ b/interfaces/CreateVerifiedFetchInit.html @@ -1,6 +1,6 @@ CreateVerifiedFetchInit | @helia/verified-fetch

Interface CreateVerifiedFetchInit

Instead of passing a Helia instance, you can pass a list of gateways and routers, and a HeliaHTTP instance will be created for you.

-
interface CreateVerifiedFetchInit {
    dnsResolvers?: DNSResolver[];
    gateways: string[];
    routers?: string[];
}

Properties

dnsResolvers? +
interface CreateVerifiedFetchInit {
    dnsResolvers?: DNSResolver[];
    gateways: string[];
    routers?: string[];
}

Properties

dnsResolvers? gateways routers?

Properties

Optional dnsResolvers

dnsResolvers?: DNSResolver[]

In order to parse DNSLink records, we need to resolve DNS queries. You can @@ -10,4 +10,4 @@

We use cloudflare and google's dnsJsonOverHttps resolvers by default.

Default

[dnsJsonOverHttps('https://mozilla.cloudflare-dns.com/dns-query'),dnsJsonOverHttps('https://dns.google/resolve')]
-

gateways

gateways: string[]

Optional routers

routers?: string[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

gateways

gateways: string[]

Optional routers

routers?: string[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/CreateVerifiedFetchOptions.html b/interfaces/CreateVerifiedFetchOptions.html index 0b4e18db..267a6650 100644 --- a/interfaces/CreateVerifiedFetchOptions.html +++ b/interfaces/CreateVerifiedFetchOptions.html @@ -1,8 +1,8 @@ -CreateVerifiedFetchOptions | @helia/verified-fetch

Interface CreateVerifiedFetchOptions

interface CreateVerifiedFetchOptions {
    contentTypeParser?: ContentTypeParser;
}

Properties

contentTypeParser? +CreateVerifiedFetchOptions | @helia/verified-fetch

Interface CreateVerifiedFetchOptions

interface CreateVerifiedFetchOptions {
    contentTypeParser?: ContentTypeParser;
}

Properties

contentTypeParser?

Properties

Optional contentTypeParser

contentTypeParser?: ContentTypeParser

A function to handle parsing content type from bytes. The function you provide will be passed the first set of bytes we receive from the network, and should return a string that will be used as the value for the Content-Type header in the response.

Default

undefined
-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/ResourceDetail.html b/interfaces/ResourceDetail.html index 2b8d64f1..17eaf8b7 100644 --- a/interfaces/ResourceDetail.html +++ b/interfaces/ResourceDetail.html @@ -1,2 +1,2 @@ -ResourceDetail | @helia/verified-fetch

Interface ResourceDetail

interface ResourceDetail {
    resource: Resource;
}

Properties

resource -

Properties

resource

resource: Resource

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +ResourceDetail | @helia/verified-fetch

Interface ResourceDetail

interface ResourceDetail {
    resource: Resource;
}

Properties

resource +

Properties

resource

resource: Resource

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/VerifiedFetch.html b/interfaces/VerifiedFetch.html index 68468dbc..8ee93fca 100644 --- a/interfaces/VerifiedFetch.html +++ b/interfaces/VerifiedFetch.html @@ -1,3 +1,3 @@ -VerifiedFetch | @helia/verified-fetch

Interface VerifiedFetch

interface VerifiedFetch {
    start(): Promise<void>;
    stop(): Promise<void>;
    (resource, options?): Promise<Response>;
}

Methods

start +VerifiedFetch | @helia/verified-fetch

Interface VerifiedFetch

interface VerifiedFetch {
    start(): Promise<void>;
    stop(): Promise<void>;
    (resource, options?): Promise<Response>;
}

Methods

start stop -

Methods

start

stop

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Methods

start

stop

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/VerifiedFetchInit.html b/interfaces/VerifiedFetchInit.html index ac8a50d6..9498b54f 100644 --- a/interfaces/VerifiedFetchInit.html +++ b/interfaces/VerifiedFetchInit.html @@ -2,7 +2,7 @@

This interface contains all the same fields as the options object passed to fetch in browsers, plus an onProgress option to listen for progress events.

-
interface VerifiedFetchInit {
    body?: null | BodyInit;
    cache?: RequestCache;
    credentials?: RequestCredentials;
    headers?: HeadersInit;
    integrity?: string;
    keepalive?: boolean;
    method?: string;
    mode?: RequestMode;
    onProgress?: ((evt) => void);
    redirect?: RequestRedirect;
    referrer?: string;
    referrerPolicy?: ReferrerPolicy;
    signal?: null | AbortSignal;
    window?: null;
}

Hierarchy

Properties

body? +
interface VerifiedFetchInit {
    body?: null | BodyInit;
    cache?: RequestCache;
    credentials?: RequestCredentials;
    headers?: HeadersInit;
    integrity?: string;
    keepalive?: boolean;
    method?: string;
    mode?: RequestMode;
    onProgress?: ((evt) => void);
    redirect?: RequestRedirect;
    referrer?: string;
    referrerPolicy?: ReferrerPolicy;
    signal?: null | AbortSignal;
    window?: null;
}

Hierarchy

Properties

body? cache? credentials? headers? diff --git a/types/BubbledProgressEvents.html b/types/BubbledProgressEvents.html index 5ad66875..3c44c981 100644 --- a/types/BubbledProgressEvents.html +++ b/types/BubbledProgressEvents.html @@ -1 +1 @@ -BubbledProgressEvents | @helia/verified-fetch

Type alias BubbledProgressEvents

BubbledProgressEvents: GetEvents | ResolveProgressEvents | ResolveDnsLinkProgressEvents | IPNSRoutingEvents

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +BubbledProgressEvents | @helia/verified-fetch

Type alias BubbledProgressEvents

BubbledProgressEvents: GetEvents | ResolveProgressEvents | ResolveDnsLinkProgressEvents | IPNSRoutingEvents

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/Resource.html b/types/Resource.html index 929cc941..081db546 100644 --- a/types/Resource.html +++ b/types/Resource.html @@ -1,2 +1,2 @@ Resource | @helia/verified-fetch

Type alias Resource

Resource: string | CID

The types for the first argument of the verifiedFetch function.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/VerifiedFetchProgressEvents.html b/types/VerifiedFetchProgressEvents.html index 128d222a..a5026e99 100644 --- a/types/VerifiedFetchProgressEvents.html +++ b/types/VerifiedFetchProgressEvents.html @@ -1 +1 @@ -VerifiedFetchProgressEvents | @helia/verified-fetch

Type alias VerifiedFetchProgressEvents

VerifiedFetchProgressEvents: ProgressEvent<"verified-fetch:request:start", CIDDetail> | ProgressEvent<"verified-fetch:request:info", string> | ProgressEvent<"verified-fetch:request:progress:chunk", CIDDetail> | ProgressEvent<"verified-fetch:request:end", CIDDetail> | ProgressEvent<"verified-fetch:request:error", CIDDetailError>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +VerifiedFetchProgressEvents | @helia/verified-fetch

Type alias VerifiedFetchProgressEvents

VerifiedFetchProgressEvents: ProgressEvent<"verified-fetch:request:start", CIDDetail> | ProgressEvent<"verified-fetch:request:info", string> | ProgressEvent<"verified-fetch:request:progress:chunk", CIDDetail> | ProgressEvent<"verified-fetch:request:end", CIDDetail> | ProgressEvent<"verified-fetch:request:error", CIDDetailError>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file