From 0a77d62d690542a7b22b059a8590ebd6d64839a4 Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Thu, 21 Nov 2024 15:20:09 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- .../_helia_verified_fetch.createVerifiedFetch.html | 2 +- functions/_helia_verified_fetch.verifiedFetch-1.html | 4 ++-- interfaces/_helia_verified_fetch.CIDDetail.html | 4 ++-- interfaces/_helia_verified_fetch.CIDDetailError.html | 4 ++-- .../_helia_verified_fetch.ContentTypeParser.html | 2 +- .../_helia_verified_fetch.CreateVerifiedFetchInit.html | 10 +++++----- ...elia_verified_fetch.CreateVerifiedFetchOptions.html | 8 ++++---- interfaces/_helia_verified_fetch.ResourceDetail.html | 4 ++-- interfaces/_helia_verified_fetch.VerifiedFetch.html | 4 ++-- .../_helia_verified_fetch.VerifiedFetchInit.html | 8 ++++---- types/_helia_verified_fetch.BubbledProgressEvents.html | 2 +- types/_helia_verified_fetch.Resource.html | 2 +- ...lia_verified_fetch.VerifiedFetchProgressEvents.html | 2 +- 13 files changed, 28 insertions(+), 28 deletions(-) diff --git a/functions/_helia_verified_fetch.createVerifiedFetch.html b/functions/_helia_verified_fetch.createVerifiedFetch.html index 5622058..3144ada 100644 --- a/functions/_helia_verified_fetch.createVerifiedFetch.html +++ b/functions/_helia_verified_fetch.createVerifiedFetch.html @@ -1,2 +1,2 @@ createVerifiedFetch | Helia Verified Fetch

Function createVerifiedFetch

Settings

Member Visibility

Theme

\ No newline at end of file +

Parameters

Returns Promise<VerifiedFetch>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/_helia_verified_fetch.verifiedFetch-1.html b/functions/_helia_verified_fetch.verifiedFetch-1.html index 0c7ad0f..1858e21 100644 --- a/functions/_helia_verified_fetch.verifiedFetch-1.html +++ b/functions/_helia_verified_fetch.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

startstop
\ No newline at end of file +

Methods

start

stop

Settings

Member Visibility

Theme

On This Page

startstop
\ No newline at end of file diff --git a/interfaces/_helia_verified_fetch.CIDDetail.html b/interfaces/_helia_verified_fetch.CIDDetail.html index c733799..f5a0c3f 100644 --- a/interfaces/_helia_verified_fetch.CIDDetail.html +++ b/interfaces/_helia_verified_fetch.CIDDetail.html @@ -1,3 +1,3 @@ -CIDDetail | Helia Verified Fetch

Interface CIDDetail

interface CIDDetail {
    cid: CID<unknown, number, number, Version>;
    path: string;
}

Hierarchy (view full)

Properties

cid +CIDDetail | Helia Verified Fetch

Interface CIDDetail

interface CIDDetail {
    cid: CID<unknown, number, number, Version>;
    path: string;
}

Hierarchy (view full)

Properties

cid path -

Properties

cid

cid: CID<unknown, number, number, Version>

path

path: string

Settings

Member Visibility

Theme

On This Page

cidpath
\ No newline at end of file +

Properties

cid

cid: CID<unknown, number, number, Version>

path

path: string

Settings

Member Visibility

Theme

On This Page

cidpath
\ No newline at end of file diff --git a/interfaces/_helia_verified_fetch.CIDDetailError.html b/interfaces/_helia_verified_fetch.CIDDetailError.html index 7f675b5..cbc0224 100644 --- a/interfaces/_helia_verified_fetch.CIDDetailError.html +++ b/interfaces/_helia_verified_fetch.CIDDetailError.html @@ -1,4 +1,4 @@ -CIDDetailError | Helia Verified Fetch

Interface CIDDetailError

interface CIDDetailError {
    cid: CID<unknown, number, number, Version>;
    error: Error;
    path: string;
}

Hierarchy (view full)

Properties

cid +CIDDetailError | Helia Verified Fetch

Interface CIDDetailError

interface CIDDetailError {
    cid: CID<unknown, number, number, Version>;
    error: Error;
    path: string;
}

Hierarchy (view full)

Properties

cid error path -

Properties

cid

cid: CID<unknown, number, number, Version>

error

error: Error

path

path: string

Settings

Member Visibility

Theme

On This Page

ciderrorpath
\ No newline at end of file +

Properties

cid

cid: CID<unknown, number, number, Version>

error

error: Error

path

path: string

Settings

Member Visibility

Theme

On This Page

ciderrorpath
\ No newline at end of file diff --git a/interfaces/_helia_verified_fetch.ContentTypeParser.html b/interfaces/_helia_verified_fetch.ContentTypeParser.html index 04c969a..8d50858 100644 --- a/interfaces/_helia_verified_fetch.ContentTypeParser.html +++ b/interfaces/_helia_verified_fetch.ContentTypeParser.html @@ -4,4 +4,4 @@ undefined, application/octet-stream will be used.

interface ContentTypeParser ((bytes, fileName?) => undefined | string | Promise<undefined | string>)

Settings

Member Visibility

Theme

\ No newline at end of file +

Parameters

Returns undefined | string | Promise<undefined | string>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/interfaces/_helia_verified_fetch.CreateVerifiedFetchInit.html b/interfaces/_helia_verified_fetch.CreateVerifiedFetchInit.html index d3cea22..e7254b6 100644 --- a/interfaces/_helia_verified_fetch.CreateVerifiedFetchInit.html +++ b/interfaces/_helia_verified_fetch.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 {
    allowInsecure?: boolean;
    allowLocal?: boolean;
    dnsResolvers?: DNSResolver[] | DNSResolvers;
    gateways: string[];
    libp2pConfig?: Partial<Libp2pOptions<ServiceMap>>;
    routers?: string[];
}

Properties

allowInsecure? +
interface CreateVerifiedFetchInit {
    allowInsecure?: boolean;
    allowLocal?: boolean;
    dnsResolvers?: DNSResolver[] | DNSResolvers;
    gateways: string[];
    libp2pConfig?: Partial<Libp2pOptions<ServiceMap>>;
    routers?: string[];
}

Properties

allowInsecure? allowLocal? dnsResolvers? gateways @@ -14,23 +14,23 @@ useful in testing environments.

Default

false
-

Optional allowLocal

allowLocal?: boolean

By default we will not connect to any HTTP Gateways providers over local or +

Optional allowLocal

allowLocal?: boolean

By default we will not connect to any HTTP Gateways providers over local or loopback addresses, this is because they are typically running on remote peers that have published private addresses by mistate.

Pass true here to connect to local Gateways as well, this may be useful in testing environments.

Default

false
-

Optional dnsResolvers

dnsResolvers?: DNSResolver[] | DNSResolvers

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

Optional dnsResolvers

dnsResolvers?: DNSResolver[] | DNSResolvers

In order to parse DNSLink records, we need to resolve DNS queries. You can pass a list of DNS resolvers that we will provide to the @helia/ipns instance for you. You must construct them using the dnsJsonOverHttps or dnsOverHttps functions exported from @helia/ipns/dns-resolvers.

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

Default

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

gateways

gateways: string[]

Optional libp2pConfig

libp2pConfig?: Partial<Libp2pOptions<ServiceMap>>

We will instantiate a libp2p node for you, but if you want to override the libp2p configuration, +

gateways

gateways: string[]

Optional libp2pConfig

libp2pConfig?: Partial<Libp2pOptions<ServiceMap>>

We will instantiate a libp2p node for you, but if you want to override the libp2p configuration, you can pass it here.

WARNING: We use Object.assign to merge the default libp2p configuration from Helia with the one you pass here, which results in a shallow merge. If you need a deep merge, you should do it yourself before passing the configuration here.

-

Optional routers

routers?: string[]

Settings

Member Visibility

Theme

On This Page

allowInsecureallowLocaldnsResolversgatewayslibp2pConfigrouters
\ No newline at end of file +

Optional routers

routers?: string[]

Settings

Member Visibility

Theme

On This Page

allowInsecureallowLocaldnsResolversgatewayslibp2pConfigrouters
\ No newline at end of file diff --git a/interfaces/_helia_verified_fetch.CreateVerifiedFetchOptions.html b/interfaces/_helia_verified_fetch.CreateVerifiedFetchOptions.html index 40bfe89..68a77b3 100644 --- a/interfaces/_helia_verified_fetch.CreateVerifiedFetchOptions.html +++ b/interfaces/_helia_verified_fetch.CreateVerifiedFetchOptions.html @@ -1,4 +1,4 @@ -CreateVerifiedFetchOptions | Helia Verified Fetch

Interface CreateVerifiedFetchOptions

interface CreateVerifiedFetchOptions {
    contentTypeParser?: ContentTypeParser;
    sessionCacheSize?: number;
    sessionTTLms?: number;
}

Properties

contentTypeParser? +CreateVerifiedFetchOptions | Helia Verified Fetch

Interface CreateVerifiedFetchOptions

interface CreateVerifiedFetchOptions {
    contentTypeParser?: ContentTypeParser;
    sessionCacheSize?: number;
    sessionTTLms?: number;
}

Properties

contentTypeParser? sessionCacheSize? sessionTTLms?

Properties

Optional contentTypeParser

contentTypeParser?: ContentTypeParser

A function to handle parsing content type from bytes. The function you @@ -7,12 +7,12 @@ Content-Type header in the response.

Default

undefined
-

Optional sessionCacheSize

sessionCacheSize?: number

Blockstore sessions are cached for reuse with requests with the same +

Optional sessionCacheSize

sessionCacheSize?: number

Blockstore sessions are cached for reuse with requests with the same base URL or CID. This parameter controls how many to cache. Once this limit is reached older/less used sessions will be evicted from the cache.

Default

100
-

Optional sessionTTLms

sessionTTLms?: number

How long each blockstore session should stay in the cache for.

+

Optional sessionTTLms

sessionTTLms?: number

How long each blockstore session should stay in the cache for.

Default

60000
-

Settings

Member Visibility

Theme

On This Page

contentTypeParsersessionCacheSizesessionTTLms
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

contentTypeParsersessionCacheSizesessionTTLms
\ No newline at end of file diff --git a/interfaces/_helia_verified_fetch.ResourceDetail.html b/interfaces/_helia_verified_fetch.ResourceDetail.html index 28d27c9..14d6d45 100644 --- a/interfaces/_helia_verified_fetch.ResourceDetail.html +++ b/interfaces/_helia_verified_fetch.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

resource
\ 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

resource
\ No newline at end of file diff --git a/interfaces/_helia_verified_fetch.VerifiedFetch.html b/interfaces/_helia_verified_fetch.VerifiedFetch.html index fd4f9c6..bc0afd7 100644 --- a/interfaces/_helia_verified_fetch.VerifiedFetch.html +++ b/interfaces/_helia_verified_fetch.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

startstop
\ No newline at end of file +

Methods

start

stop

Settings

Member Visibility

Theme

On This Page

startstop
\ No newline at end of file diff --git a/interfaces/_helia_verified_fetch.VerifiedFetchInit.html b/interfaces/_helia_verified_fetch.VerifiedFetchInit.html index fe22f90..5bcf39b 100644 --- a/interfaces/_helia_verified_fetch.VerifiedFetchInit.html +++ b/interfaces/_helia_verified_fetch.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 {
    allowInsecure?: boolean;
    allowLocal?: boolean;
    body?: null | BodyInit;
    cache?: RequestCache;
    credentials?: RequestCredentials;
    headers?: HeadersInit;
    integrity?: string;
    keepalive?: boolean;
    method?: string;
    mode?: RequestMode;
    onProgress?: ((evt) => void);
    priority?: RequestPriority;
    redirect?: RequestRedirect;
    referrer?: string;
    referrerPolicy?: ReferrerPolicy;
    session?: boolean;
    signal?: null | AbortSignal;
    window?: null;
}

Hierarchy

Properties

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

Hierarchy

Properties

allowInsecure? allowLocal? body? cache? @@ -28,14 +28,14 @@ useful in testing environments.

Default

false
-

Optional allowLocal

allowLocal?: boolean

By default we will not connect to any HTTP Gateways providers over local or +

Optional allowLocal

allowLocal?: boolean

By default we will not connect to any HTTP Gateways providers over local or loopback addresses, this is because they are typically running on remote peers that have published private addresses by mistate.

Pass true here to connect to local Gateways as well, this may be useful in testing environments.

Default

false
-

Optional body

body?: null | BodyInit

A BodyInit object or null to set request's body.

+

Optional body

body?: null | BodyInit

A BodyInit object or null to set request's body.

Optional cache

cache?: RequestCache

A string indicating how the request will interact with the browser's cache to set request's cache.

Optional credentials

credentials?: RequestCredentials

A string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. Sets request's credentials.

Optional headers

headers?: HeadersInit

A Headers object, an object literal, or an array of two-item arrays to set request's headers.

@@ -57,6 +57,6 @@ argument is true for both fetch requests.

Default

true
-

Optional signal

signal?: null | AbortSignal

An AbortSignal to set request's signal.

+

Optional signal

signal?: null | AbortSignal

An AbortSignal to set request's signal.

Optional window

window?: null

Can only be null. Used to disassociate request from any Window.

Settings

Member Visibility

Theme

On This Page

allowInsecureallowLocalbodycachecredentialsheadersintegritykeepalivemethodmodeonProgresspriorityredirectreferrerreferrerPolicysessionsignalwindow
\ No newline at end of file diff --git a/types/_helia_verified_fetch.BubbledProgressEvents.html b/types/_helia_verified_fetch.BubbledProgressEvents.html index f86e9da..6ef2f65 100644 --- a/types/_helia_verified_fetch.BubbledProgressEvents.html +++ b/types/_helia_verified_fetch.BubbledProgressEvents.html @@ -1 +1 @@ -BubbledProgressEvents | Helia Verified Fetch

Type alias BubbledProgressEvents

BubbledProgressEvents: ExporterProgressEvents | GetBlockProgressEvents | ResolveDNSLinkProgressEvents

Settings

Member Visibility

Theme

\ No newline at end of file +BubbledProgressEvents | Helia Verified Fetch

Type alias BubbledProgressEvents

BubbledProgressEvents: ExporterProgressEvents | GetBlockProgressEvents | ResolveDNSLinkProgressEvents

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/_helia_verified_fetch.Resource.html b/types/_helia_verified_fetch.Resource.html index 8d89d42..ba2f28a 100644 --- a/types/_helia_verified_fetch.Resource.html +++ b/types/_helia_verified_fetch.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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/_helia_verified_fetch.VerifiedFetchProgressEvents.html b/types/_helia_verified_fetch.VerifiedFetchProgressEvents.html index c5668ca..d8e143b 100644 --- a/types/_helia_verified_fetch.VerifiedFetchProgressEvents.html +++ b/types/_helia_verified_fetch.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

\ 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

\ No newline at end of file