From 703684fe2e40910248fda724f393185e85b01235 Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Thu, 14 Nov 2024 21:54:44 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- functions/_helia_verified_fetch.createVerifiedFetch.html | 2 +- functions/_helia_verified_fetch.verifiedFetch-1.html | 4 ++-- index.html | 2 +- interfaces/_helia_verified_fetch.CIDDetail.html | 4 ++-- interfaces/_helia_verified_fetch.CIDDetailError.html | 4 ++-- interfaces/_helia_verified_fetch.ContentTypeParser.html | 2 +- .../_helia_verified_fetch.CreateVerifiedFetchInit.html | 8 ++++---- .../_helia_verified_fetch.CreateVerifiedFetchOptions.html | 8 ++++---- interfaces/_helia_verified_fetch.ResourceDetail.html | 4 ++-- interfaces/_helia_verified_fetch.VerifiedFetch.html | 4 ++-- interfaces/_helia_verified_fetch.VerifiedFetchInit.html | 8 ++++---- types/_helia_verified_fetch.BubbledProgressEvents.html | 2 +- types/_helia_verified_fetch.Resource.html | 2 +- ..._helia_verified_fetch.VerifiedFetchProgressEvents.html | 2 +- 14 files changed, 28 insertions(+), 28 deletions(-) diff --git a/functions/_helia_verified_fetch.createVerifiedFetch.html b/functions/_helia_verified_fetch.createVerifiedFetch.html index c849fa65..ed7580c3 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 0f7b0eec..b3518def 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/index.html b/index.html index 2cc3aa97..25d5fb2f 100644 --- a/index.html +++ b/index.html @@ -16,7 +16,7 @@
  • @helia/verified-fetch-interop Interop tests for @helia/verified-fetch

    • API Docs

    License

    Licensed under either of

    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 2aa193c4..2a8aa190 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[];
        routers?: string[];
    }

    Properties

    allowInsecure? +
    interface CreateVerifiedFetchInit {
        allowInsecure?: boolean;
        allowLocal?: boolean;
        dnsResolvers?: DNSResolver[] | DNSResolvers;
        gateways: string[];
        routers?: string[];
    }

    Properties

    allowInsecure? allowLocal? dnsResolvers? gateways @@ -13,18 +13,18 @@ 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 routers

    routers?: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    allowInsecureallowLocaldnsResolversgatewaysrouters
    \ No newline at end of file +

    gateways

    gateways: string[]

    Optional routers

    routers?: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    allowInsecureallowLocaldnsResolversgatewaysrouters
    \ No newline at end of file diff --git a/interfaces/_helia_verified_fetch.CreateVerifiedFetchOptions.html b/interfaces/_helia_verified_fetch.CreateVerifiedFetchOptions.html index 131b2f7f..0efd0abd 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 b4f18842..02a6a6b2 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 f4f0e861..33d5b7a2 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 9206d136..663e3530 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 090fbd94..56c0836d 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 ef6f91ab..62fb5bdd 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 8ceb7b3e..6fa4397c 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