From 87a847449f8b8991f85c7eeee0314df5aedb7209 Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Fri, 8 Dec 2023 00:52:20 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- functions/index.ipns-1.html | 2 +- functions/routing.dht.html | 2 +- functions/routing.pubsub.html | 2 +- interfaces/index.DNSResolver.html | 2 +- interfaces/index.IPNS.html | 12 ++++++------ interfaces/index.IPNSComponents.html | 4 ++-- interfaces/index.IPNSOptions.html | 4 ++-- interfaces/index.PublishOptions.html | 8 ++++---- interfaces/index.RepublishOptions.html | 4 ++-- interfaces/index.ResolveDNSOptions.html | 8 ++++---- interfaces/index.ResolveDnsLinkOptions.html | 4 ++-- interfaces/index.ResolveOptions.html | 4 ++-- interfaces/routing.GetOptions.html | 2 +- interfaces/routing.IPNSRouting.html | 4 ++-- interfaces/routing.PutOptions.html | 2 +- modules/index.html | 2 +- modules/routing.html | 2 +- types/index.PublishProgressEvents.html | 2 +- types/index.RepublishProgressEvents.html | 2 +- types/index.ResolveDnsLinkProgressEvents.html | 2 +- types/index.ResolveProgressEvents.html | 2 +- types/routing.IPNSRoutingEvents.html | 2 +- 22 files changed, 39 insertions(+), 39 deletions(-) diff --git a/functions/index.ipns-1.html b/functions/index.ipns-1.html index 5e80c7b..53750f6 100644 --- a/functions/index.ipns-1.html +++ b/functions/index.ipns-1.html @@ -1 +1 @@ -ipns | @helia/ipns

Generated using TypeDoc

\ No newline at end of file +ipns | @helia/ipns

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/routing.dht.html b/functions/routing.dht.html index a1a9e25..ac87c09 100644 --- a/functions/routing.dht.html +++ b/functions/routing.dht.html @@ -1 +1 @@ -dht | @helia/ipns

Generated using TypeDoc

\ No newline at end of file +dht | @helia/ipns

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/routing.pubsub.html b/functions/routing.pubsub.html index 2d58f0c..902950b 100644 --- a/functions/routing.pubsub.html +++ b/functions/routing.pubsub.html @@ -1 +1 @@ -pubsub | @helia/ipns

Generated using TypeDoc

\ No newline at end of file +pubsub | @helia/ipns

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/index.DNSResolver.html b/interfaces/index.DNSResolver.html index 7a24efc..4ad473a 100644 --- a/interfaces/index.DNSResolver.html +++ b/interfaces/index.DNSResolver.html @@ -1 +1 @@ -DNSResolver | @helia/ipns

Interface DNSResolver

interface DNSResolver ((domain, options?) => Promise<string>)

Generated using TypeDoc

\ No newline at end of file +DNSResolver | @helia/ipns

Interface DNSResolver

interface DNSResolver ((domain, options?) => Promise<string>)

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/index.IPNS.html b/interfaces/index.IPNS.html index 4a99b47..2ac6402 100644 --- a/interfaces/index.IPNS.html +++ b/interfaces/index.IPNS.html @@ -1,11 +1,11 @@ -IPNS | @helia/ipns

Interface IPNS

interface IPNS {
    publish(key, value, options?): Promise<IPNSRecord>;
    republish(options?): void;
    resolve(key, options?): Promise<CID<unknown, number, number, Version>>;
    resolveDns(domain, options?): Promise<CID<unknown, number, number, Version>>;
}

Methods

publish +IPNS | @helia/ipns

Interface IPNS

interface IPNS {
    publish(key, value, options?): Promise<IPNSRecord>;
    republish(options?): void;
    resolve(key, options?): Promise<CID<unknown, number, number, Version>>;
    resolveDns(domain, options?): Promise<CID<unknown, number, number, Version>>;
}

Methods

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<CID<unknown, number, number, Version>>

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/index.IPNSComponents.html b/interfaces/index.IPNSComponents.html index 0bc0465..2e847b8 100644 --- a/interfaces/index.IPNSComponents.html +++ b/interfaces/index.IPNSComponents.html @@ -1,2 +1,2 @@ -IPNSComponents | @helia/ipns

Interface IPNSComponents

interface IPNSComponents {
    datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
}

Properties

Properties

datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

Type declaration

    Type declaration

      Type declaration

        Type declaration

          Type declaration

            Type declaration

              Type declaration

                Type declaration

                  Type declaration

                    Type declaration

                      Generated using TypeDoc

                      \ No newline at end of file +IPNSComponents | @helia/ipns

                      Interface IPNSComponents

                      interface IPNSComponents {
                          datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                      }

                      Properties

                      Properties

                      datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                      Type declaration

                        Type declaration

                          Type declaration

                            Type declaration

                              Type declaration

                                Type declaration

                                  Type declaration

                                    Type declaration

                                      Type declaration

                                        Type declaration

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/index.IPNSOptions.html b/interfaces/index.IPNSOptions.html index 554cb15..4ebb745 100644 --- a/interfaces/index.IPNSOptions.html +++ b/interfaces/index.IPNSOptions.html @@ -1,3 +1,3 @@ -IPNSOptions | @helia/ipns

                                          Interface IPNSOptions

                                          interface IPNSOptions {
                                              resolvers?: DNSResolver[];
                                              routers?: IPNSRouting[];
                                          }

                                          Properties

                                          resolvers? +IPNSOptions | @helia/ipns

                                          Interface IPNSOptions

                                          interface IPNSOptions {
                                              resolvers?: DNSResolver[];
                                              routers?: IPNSRouting[];
                                          }

                                          Properties

                                          Properties

                                          resolvers?: DNSResolver[]
                                          routers?: IPNSRouting[]

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Properties

                                          resolvers?: DNSResolver[]
                                          routers?: IPNSRouting[]

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/index.PublishOptions.html b/interfaces/index.PublishOptions.html index 4c74514..2bbd59d 100644 --- a/interfaces/index.PublishOptions.html +++ b/interfaces/index.PublishOptions.html @@ -1,10 +1,10 @@ -PublishOptions | @helia/ipns

                                          Interface PublishOptions

                                          interface PublishOptions {
                                              lifetime?: number;
                                              offline?: boolean;
                                              onProgress?: ((evt) => void);
                                              signal?: AbortSignal;
                                              v1Compatible?: boolean;
                                          }

                                          Hierarchy

                                          Properties

                                          lifetime? +PublishOptions | @helia/ipns

                                          Interface PublishOptions

                                          interface PublishOptions {
                                              lifetime?: number;
                                              offline?: boolean;
                                              onProgress?: ((evt) => void);
                                              signal?: AbortSignal;
                                              v1Compatible?: boolean;
                                          }

                                          Hierarchy

                                          Properties

                                          lifetime?: number

                                          Time duration of the record in ms (default: 24hrs)

                                          -
                                          offline?: boolean

                                          Only publish to a local datastore (default: false)

                                          -
                                          onProgress?: ((evt) => void)

                                          Type declaration

                                          signal?: AbortSignal
                                          v1Compatible?: boolean

                                          By default a IPNS V1 and a V2 signature is added to every record. Pass +

                                          offline?: boolean

                                          Only publish to a local datastore (default: false)

                                          +
                                          onProgress?: ((evt) => void)

                                          Type declaration

                                          signal?: AbortSignal
                                          v1Compatible?: boolean

                                          By default a IPNS V1 and a V2 signature is added to every record. Pass false here to only add a V2 signature. (default: true)

                                          -

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/index.RepublishOptions.html b/interfaces/index.RepublishOptions.html index 6cbaa64..537fbed 100644 --- a/interfaces/index.RepublishOptions.html +++ b/interfaces/index.RepublishOptions.html @@ -1,5 +1,5 @@ -RepublishOptions | @helia/ipns

                                          Interface RepublishOptions

                                          interface RepublishOptions {
                                              interval?: number;
                                              onProgress?: ((evt) => void);
                                              signal?: AbortSignal;
                                          }

                                          Hierarchy

                                          Properties

                                          interval? +RepublishOptions | @helia/ipns

                                          Interface RepublishOptions

                                          interface RepublishOptions {
                                              interval?: number;
                                              onProgress?: ((evt) => void);
                                              signal?: AbortSignal;
                                          }

                                          Hierarchy

                                          Properties

                                          interval?: number

                                          The republish interval in ms (default: 23hrs)

                                          -
                                          onProgress?: ((evt) => void)

                                          Type declaration

                                          signal?: AbortSignal

                                          Generated using TypeDoc

                                          \ No newline at end of file +
                                          onProgress?: ((evt) => void)

                                          Type declaration

                                          signal?: AbortSignal

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/index.ResolveDNSOptions.html b/interfaces/index.ResolveDNSOptions.html index 34d7a20..c782480 100644 --- a/interfaces/index.ResolveDNSOptions.html +++ b/interfaces/index.ResolveDNSOptions.html @@ -1,11 +1,11 @@ -ResolveDNSOptions | @helia/ipns

                                          Interface ResolveDNSOptions

                                          interface ResolveDNSOptions {
                                              nocache?: boolean;
                                              offline?: boolean;
                                              onProgress?: ((evt) => void);
                                              resolvers?: DNSResolver[];
                                              signal?: AbortSignal;
                                          }

                                          Hierarchy

                                          Properties

                                          nocache? +ResolveDNSOptions | @helia/ipns

                                          Interface ResolveDNSOptions

                                          interface ResolveDNSOptions {
                                              nocache?: boolean;
                                              offline?: boolean;
                                              onProgress?: ((evt) => void);
                                              resolvers?: DNSResolver[];
                                              signal?: AbortSignal;
                                          }

                                          Hierarchy

                                          Properties

                                          nocache?: boolean

                                          Do not use cached DNS entries (default: false)

                                          -
                                          offline?: boolean

                                          Do not query the network for the IPNS record (default: false)

                                          -
                                          onProgress?: ((evt) => void)

                                          Type declaration

                                          resolvers?: DNSResolver[]

                                          These resolvers will be used to resolve the dnslink entries, if unspecified node will +

                                          offline?: boolean

                                          Do not query the network for the IPNS record (default: false)

                                          +
                                          onProgress?: ((evt) => void)

                                          Type declaration

                                          resolvers?: DNSResolver[]

                                          These resolvers will be used to resolve the dnslink entries, if unspecified node will fall back to the dns module and browsers fall back to querying google/cloudflare DoH

                                          signal?: AbortSignal

                                          Generated using TypeDoc

                                          \ No newline at end of file +
                                          signal?: AbortSignal

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/index.ResolveDnsLinkOptions.html b/interfaces/index.ResolveDnsLinkOptions.html index 9ed7056..5d8bef5 100644 --- a/interfaces/index.ResolveDnsLinkOptions.html +++ b/interfaces/index.ResolveDnsLinkOptions.html @@ -1,5 +1,5 @@ -ResolveDnsLinkOptions | @helia/ipns

                                          Interface ResolveDnsLinkOptions

                                          interface ResolveDnsLinkOptions {
                                              nocache?: boolean;
                                              onProgress?: ((evt) => void);
                                              signal?: AbortSignal;
                                          }

                                          Hierarchy

                                          Properties

                                          nocache? +ResolveDnsLinkOptions | @helia/ipns

                                          Interface ResolveDnsLinkOptions

                                          interface ResolveDnsLinkOptions {
                                              nocache?: boolean;
                                              onProgress?: ((evt) => void);
                                              signal?: AbortSignal;
                                          }

                                          Hierarchy

                                          Properties

                                          nocache?: boolean

                                          Do not use cached DNS entries (default: false)

                                          -
                                          onProgress?: ((evt) => void)

                                          Type declaration

                                          signal?: AbortSignal

                                          Generated using TypeDoc

                                          \ No newline at end of file +
                                          onProgress?: ((evt) => void)

                                          Type declaration

                                          signal?: AbortSignal

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/index.ResolveOptions.html b/interfaces/index.ResolveOptions.html index 1fbd4a2..5a45a55 100644 --- a/interfaces/index.ResolveOptions.html +++ b/interfaces/index.ResolveOptions.html @@ -1,5 +1,5 @@ -ResolveOptions | @helia/ipns

                                          Interface ResolveOptions

                                          interface ResolveOptions {
                                              offline?: boolean;
                                              onProgress?: ((evt) => void);
                                              signal?: AbortSignal;
                                          }

                                          Hierarchy

                                          Properties

                                          offline? +ResolveOptions | @helia/ipns

                                          Interface ResolveOptions

                                          interface ResolveOptions {
                                              offline?: boolean;
                                              onProgress?: ((evt) => void);
                                              signal?: AbortSignal;
                                          }

                                          Hierarchy

                                          Properties

                                          offline?: boolean

                                          Do not query the network for the IPNS record (default: false)

                                          -
                                          onProgress?: ((evt) => void)

                                          Type declaration

                                          signal?: AbortSignal

                                          Generated using TypeDoc

                                          \ No newline at end of file +
                                          onProgress?: ((evt) => void)

                                          Type declaration

                                          signal?: AbortSignal

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/routing.GetOptions.html b/interfaces/routing.GetOptions.html index da7ccf2..f097e82 100644 --- a/interfaces/routing.GetOptions.html +++ b/interfaces/routing.GetOptions.html @@ -1,3 +1,3 @@ -GetOptions | @helia/ipns

                                          Interface GetOptions

                                          interface GetOptions {
                                              onProgress?: ((evt) => void);
                                              signal?: AbortSignal;
                                          }

                                          Hierarchy

                                          Properties

                                          onProgress? +GetOptions | @helia/ipns

                                          Interface GetOptions

                                          interface GetOptions {
                                              onProgress?: ((evt) => void);
                                              signal?: AbortSignal;
                                          }

                                          Hierarchy

                                          Properties

                                          Properties

                                          onProgress?: ((evt) => void)

                                          Type declaration

                                            • (evt): void
                                            • Parameters

                                              • evt: any

                                              Returns void

                                          signal?: AbortSignal

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/routing.IPNSRouting.html b/interfaces/routing.IPNSRouting.html index 908e3a5..bacb19a 100644 --- a/interfaces/routing.IPNSRouting.html +++ b/interfaces/routing.IPNSRouting.html @@ -1,3 +1,3 @@ -IPNSRouting | @helia/ipns

                                          Interface IPNSRouting

                                          interface IPNSRouting {
                                              get(routingKey, options?): Promise<Uint8Array>;
                                              put(routingKey, marshaledRecord, options?): Promise<void>;
                                          }

                                          Methods

                                          get +IPNSRouting | @helia/ipns

                                          Interface IPNSRouting

                                          interface IPNSRouting {
                                              get(routingKey, options?): Promise<Uint8Array>;
                                              put(routingKey, marshaledRecord, options?): Promise<void>;
                                          }

                                          Methods

                                          Methods

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Methods

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/interfaces/routing.PutOptions.html b/interfaces/routing.PutOptions.html index 8bc5e31..c57ef59 100644 --- a/interfaces/routing.PutOptions.html +++ b/interfaces/routing.PutOptions.html @@ -1,3 +1,3 @@ -PutOptions | @helia/ipns

                                          Interface PutOptions

                                          interface PutOptions {
                                              onProgress?: ((evt) => void);
                                              signal?: AbortSignal;
                                          }

                                          Hierarchy

                                          Properties

                                          onProgress? +PutOptions | @helia/ipns

                                          Interface PutOptions

                                          interface PutOptions {
                                              onProgress?: ((evt) => void);
                                              signal?: AbortSignal;
                                          }

                                          Hierarchy

                                          Properties

                                          Properties

                                          onProgress?: ((evt) => void)

                                          Type declaration

                                            • (evt): void
                                            • Parameters

                                              • evt: any

                                              Returns void

                                          signal?: AbortSignal

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/modules/index.html b/modules/index.html index fc506ad..c023daf 100644 --- a/modules/index.html +++ b/modules/index.html @@ -18,7 +18,7 @@

                                          Example

                                          DNS-JSON-Over-HTTPS resolvers use the RFC 8427 applicat result in a smaller browser bundle due to the response being plain JSON.

                                          // use DNS-JSON-Over-HTTPS
                                          import { dnsJsonOverHttps } from '@helia/ipns/dns-resolvers'

                                          const cid = name.resolveDns('ipfs.io', {
                                          resolvers: [
                                          dnsJsonOverHttps('https://mozilla.cloudflare-dns.com/dns-query')
                                          ]
                                          })
                                          -

                                          References

                                          References

                                          Interfaces

                                          DNSResolver IPNS IPNSComponents diff --git a/modules/routing.html b/modules/routing.html index 3e008c2..7dad1a7 100644 --- a/modules/routing.html +++ b/modules/routing.html @@ -1,4 +1,4 @@ -routing | @helia/ipns

                                          Module routing

                                          Index

                                          Interfaces

                                          GetOptions +routing | @helia/ipns

                                          Module routing

                                          Index

                                          Interfaces

                                          Type Aliases

                                          IPNSRoutingEvents diff --git a/types/index.PublishProgressEvents.html b/types/index.PublishProgressEvents.html index 61e1d5e..a77a17c 100644 --- a/types/index.PublishProgressEvents.html +++ b/types/index.PublishProgressEvents.html @@ -1 +1 @@ -PublishProgressEvents | @helia/ipns

                                          Type alias PublishProgressEvents

                                          PublishProgressEvents: ProgressEvent<"ipns:publish:start"> | ProgressEvent<"ipns:publish:success", IPNSRecord> | ProgressEvent<"ipns:publish:error", Error>

                                          Generated using TypeDoc

                                          \ No newline at end of file +PublishProgressEvents | @helia/ipns

                                          Type alias PublishProgressEvents

                                          PublishProgressEvents: ProgressEvent<"ipns:publish:start"> | ProgressEvent<"ipns:publish:success", IPNSRecord> | ProgressEvent<"ipns:publish:error", Error>

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/types/index.RepublishProgressEvents.html b/types/index.RepublishProgressEvents.html index 4c84169..628c2eb 100644 --- a/types/index.RepublishProgressEvents.html +++ b/types/index.RepublishProgressEvents.html @@ -1 +1 @@ -RepublishProgressEvents | @helia/ipns

                                          Type alias RepublishProgressEvents

                                          RepublishProgressEvents: ProgressEvent<"ipns:republish:start", unknown> | ProgressEvent<"ipns:republish:success", IPNSRecord> | ProgressEvent<"ipns:republish:error", {
                                              err: Error;
                                              record: IPNSRecord;
                                          }>

                                          Generated using TypeDoc

                                          \ No newline at end of file +RepublishProgressEvents | @helia/ipns

                                          Type alias RepublishProgressEvents

                                          RepublishProgressEvents: ProgressEvent<"ipns:republish:start", unknown> | ProgressEvent<"ipns:republish:success", IPNSRecord> | ProgressEvent<"ipns:republish:error", {
                                              err: Error;
                                              record: IPNSRecord;
                                          }>

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/types/index.ResolveDnsLinkProgressEvents.html b/types/index.ResolveDnsLinkProgressEvents.html index 9d39793..2a925f9 100644 --- a/types/index.ResolveDnsLinkProgressEvents.html +++ b/types/index.ResolveDnsLinkProgressEvents.html @@ -1 +1 @@ -ResolveDnsLinkProgressEvents | @helia/ipns

                                          Type alias ResolveDnsLinkProgressEvents

                                          ResolveDnsLinkProgressEvents: ProgressEvent<"dnslink:cache", string> | ProgressEvent<"dnslink:query", string> | ProgressEvent<"dnslink:answer", DNSResponse>

                                          Generated using TypeDoc

                                          \ No newline at end of file +ResolveDnsLinkProgressEvents | @helia/ipns

                                          Type alias ResolveDnsLinkProgressEvents

                                          ResolveDnsLinkProgressEvents: ProgressEvent<"dnslink:cache", string> | ProgressEvent<"dnslink:query", string> | ProgressEvent<"dnslink:answer", DNSResponse>

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/types/index.ResolveProgressEvents.html b/types/index.ResolveProgressEvents.html index 7e0cbac..7139124 100644 --- a/types/index.ResolveProgressEvents.html +++ b/types/index.ResolveProgressEvents.html @@ -1 +1 @@ -ResolveProgressEvents | @helia/ipns

                                          Type alias ResolveProgressEvents

                                          ResolveProgressEvents: ProgressEvent<"ipns:resolve:start", unknown> | ProgressEvent<"ipns:resolve:success", IPNSRecord> | ProgressEvent<"ipns:resolve:error", Error>

                                          Generated using TypeDoc

                                          \ No newline at end of file +ResolveProgressEvents | @helia/ipns

                                          Type alias ResolveProgressEvents

                                          ResolveProgressEvents: ProgressEvent<"ipns:resolve:start", unknown> | ProgressEvent<"ipns:resolve:success", IPNSRecord> | ProgressEvent<"ipns:resolve:error", Error>

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/types/routing.IPNSRoutingEvents.html b/types/routing.IPNSRoutingEvents.html index d51f644..2c694ed 100644 --- a/types/routing.IPNSRoutingEvents.html +++ b/types/routing.IPNSRoutingEvents.html @@ -1 +1 @@ -IPNSRoutingEvents | @helia/ipns

                                          Generated using TypeDoc

                                          \ No newline at end of file +IPNSRoutingEvents | @helia/ipns

                                          Generated using TypeDoc

                                          \ No newline at end of file