docs: update documentation [skip ci]

ipfs · Jan 12, 2024 · 06d16f4 · 06d16f4
1 parent aff9596
commit 06d16f4
Show file tree

Hide file tree

Showing 193 changed files with 1,546 additions and 353 deletions.
diff --git a/assets/navigation.js b/assets/navigation.js
diff --git a/assets/search.js b/assets/search.js
diff --git a/classes/_helia_block_brokers.NetworkedStorage.html b/classes/_helia_block_brokers.NetworkedStorage.html
diff --git a/classes/_helia_block_brokers.index.NetworkedStorage.html b/classes/_helia_block_brokers.index.NetworkedStorage.html
diff --git a/classes/_helia_unixfs.errors.AlreadyExistsError.html b/classes/_helia_unixfs.errors.AlreadyExistsError.html
diff --git a/classes/_helia_unixfs.errors.DoesNotExistError.html b/classes/_helia_unixfs.errors.DoesNotExistError.html
diff --git a/classes/_helia_unixfs.errors.InvalidPBNodeError.html b/classes/_helia_unixfs.errors.InvalidPBNodeError.html
diff --git a/classes/_helia_unixfs.errors.InvalidParametersError.html b/classes/_helia_unixfs.errors.InvalidParametersError.html
diff --git a/classes/_helia_unixfs.errors.NoContentError.html b/classes/_helia_unixfs.errors.NoContentError.html
diff --git a/classes/_helia_unixfs.errors.NotADirectoryError.html b/classes/_helia_unixfs.errors.NotADirectoryError.html
diff --git a/classes/_helia_unixfs.errors.NotAFileError.html b/classes/_helia_unixfs.errors.NotAFileError.html
diff --git a/classes/_helia_unixfs.errors.NotUnixFSError.html b/classes/_helia_unixfs.errors.NotUnixFSError.html
diff --git a/classes/_helia_unixfs.errors.UnixFSError.html b/classes/_helia_unixfs.errors.UnixFSError.html
diff --git a/classes/_helia_unixfs.errors.UnknownError.html b/classes/_helia_unixfs.errors.UnknownError.html
diff --git a/functions/_helia_block_brokers.bitswap.html b/functions/_helia_block_brokers.bitswap.html
diff --git a/functions/_helia_block_brokers.index.bitswap.html b/functions/_helia_block_brokers.index.bitswap.html
diff --git a/functions/_helia_block_brokers.index.trustlessGateway.html b/functions/_helia_block_brokers.index.trustlessGateway.html
diff --git a/functions/helia.index.createHelia.html → ...helia_block_brokers.trustlessGateway.html b/functions/helia.index.createHelia.html → ...helia_block_brokers.trustlessGateway.html
diff --git a/functions/_helia_block_brokers.utils_default_hashers.defaultHashers.html b/functions/_helia_block_brokers.utils_default_hashers.defaultHashers.html
diff --git a/functions/_helia_car.car-1.html b/functions/_helia_car.car-1.html
diff --git a/functions/_helia_dag_cbor.dagCbor-1.html b/functions/_helia_dag_cbor.dagCbor-1.html
diff --git a/functions/_helia_dag_json.dagJson-1.html b/functions/_helia_dag_json.dagJson-1.html
diff --git a/functions/_helia_ipns.dns_resolvers.dnsJsonOverHttps.html b/functions/_helia_ipns.dns_resolvers.dnsJsonOverHttps.html
diff --git a/..._block_brokers.utils_default_hashers.html → ...elia_ipns.dns_resolvers.dnsOverHttps.html b/..._block_brokers.utils_default_hashers.html → ...elia_ipns.dns_resolvers.dnsOverHttps.html
diff --git a/functions/_helia_ipns.index.ipns-1.html b/functions/_helia_ipns.index.ipns-1.html
diff --git a/interfaces/helia.index.Pair.html → ...tions/_helia_ipns.index.ipnsSelector.html b/interfaces/helia.index.Pair.html → ...tions/_helia_ipns.index.ipnsSelector.html
diff --git a/functions/_helia_ipns.index.ipnsValidator.html b/functions/_helia_ipns.index.ipnsValidator.html
diff --git a/functions/_helia_ipns.routing.libp2p.html b/functions/_helia_ipns.routing.libp2p.html
diff --git a/functions/_helia_ipns.routing.pubsub.html b/functions/_helia_ipns.routing.pubsub.html
diff --git a/functions/_helia_json.json-1.html b/functions/_helia_json.json-1.html
diff --git a/functions/_helia_mfs.mfs-1.html b/functions/_helia_mfs.mfs-1.html
diff --git a/functions/_helia_strings.strings-1.html b/functions/_helia_strings.strings-1.html
diff --git a/functions/_helia_unixfs.index.globSource.html b/functions/_helia_unixfs.index.globSource.html
diff --git a/modules/_helia_block_brokers.index.html → functions/_helia_unixfs.index.unixfs-1.html b/modules/_helia_block_brokers.index.html → functions/_helia_unixfs.index.unixfs-1.html
diff --git a/functions/_helia_unixfs.index.urlSource.html b/functions/_helia_unixfs.index.urlSource.html
diff --git a/functions/helia.createHelia.html b/functions/helia.createHelia.html
diff --git a/functions/helia.libp2pDefaults.html b/functions/helia.libp2pDefaults.html
diff --git a/functions/helia.utils_default_hashers.defaultHashers.html b/functions/helia.utils_default_hashers.defaultHashers.html
diff --git a/index.html b/index.html
diff --git a/interfaces/_helia_car.Car.html b/interfaces/_helia_car.Car.html
diff --git a/interfaces/_helia_car.CarComponents.html b/interfaces/_helia_car.CarComponents.html
diff --git a/interfaces/_helia_car.CarInit.html b/interfaces/_helia_car.CarInit.html
diff --git a/interfaces/_helia_car.DAGWalker.html b/interfaces/_helia_car.DAGWalker.html
diff --git a/interfaces/_helia_dag_cbor.AddOptions.html b/interfaces/_helia_dag_cbor.AddOptions.html
diff --git a/interfaces/_helia_dag_cbor.DAGCBOR.html b/interfaces/_helia_dag_cbor.DAGCBOR.html
diff --git a/...lia.index.GetAllBlocksProgressEvents.html → ...es/_helia_dag_cbor.DAGCBORComponents.html b/...lia.index.GetAllBlocksProgressEvents.html → ...es/_helia_dag_cbor.DAGCBORComponents.html
diff --git a/interfaces/_helia_dag_cbor.GetOptions.html b/interfaces/_helia_dag_cbor.GetOptions.html
diff --git a/interfaces/_helia_dag_json.AddOptions.html b/interfaces/_helia_dag_json.AddOptions.html
diff --git a/interfaces/_helia_dag_json.DAGJSON.html b/interfaces/_helia_dag_json.DAGJSON.html
diff --git a/interfaces/_helia_dag_json.DAGJSONComponents.html b/interfaces/_helia_dag_json.DAGJSONComponents.html
diff --git a/interfaces/_helia_dag_json.GetOptions.html b/interfaces/_helia_dag_json.GetOptions.html
diff --git a/interfaces/_helia_interface.blocks.BlockAnnouncer.html b/interfaces/_helia_interface.blocks.BlockAnnouncer.html
diff --git a/interfaces/_helia_interface.blocks.BlockRetriever.html b/interfaces/_helia_interface.blocks.BlockRetriever.html
diff --git a/interfaces/_helia_interface.blocks.Blocks.html b/interfaces/_helia_interface.blocks.Blocks.html
diff --git a/interfaces/_helia_interface.blocks.GetOfflineOptions.html b/interfaces/_helia_interface.blocks.GetOfflineOptions.html
diff --git a/interfaces/_helia_interface.blocks.Pair.html b/interfaces/_helia_interface.blocks.Pair.html
diff --git a/interfaces/_helia_interface.index.GCOptions.html b/interfaces/_helia_interface.index.GCOptions.html
diff --git a/interfaces/_helia_interface.index.Helia.html b/interfaces/_helia_interface.index.Helia.html
diff --git a/interfaces/_helia_interface.pins.AddOptions.html b/interfaces/_helia_interface.pins.AddOptions.html
diff --git a/interfaces/_helia_interface.pins.IsPinnedOptions.html b/interfaces/_helia_interface.pins.IsPinnedOptions.html
diff --git a/interfaces/_helia_interface.pins.LsOptions.html b/interfaces/_helia_interface.pins.LsOptions.html
diff --git a/interfaces/_helia_interface.pins.Pin.html b/interfaces/_helia_interface.pins.Pin.html
diff --git a/interfaces/_helia_interface.pins.Pins.html b/interfaces/_helia_interface.pins.Pins.html
diff --git a/interfaces/_helia_interface.pins.RmOptions.html b/interfaces/_helia_interface.pins.RmOptions.html
diff --git a/...ia.index.GetManyBlocksProgressEvents.html → ...rfaces/_helia_ipns.index.DNSResolver.html b/...ia.index.GetManyBlocksProgressEvents.html → ...rfaces/_helia_ipns.index.DNSResolver.html
diff --git a/interfaces/_helia_ipns.index.IPNS.html b/interfaces/_helia_ipns.index.IPNS.html
diff --git a/interfaces/_helia_ipns.index.IPNSComponents.html b/interfaces/_helia_ipns.index.IPNSComponents.html
diff --git a/interfaces/_helia_ipns.index.IPNSOptions.html b/interfaces/_helia_ipns.index.IPNSOptions.html
diff --git a/interfaces/_helia_ipns.index.PublishOptions.html b/interfaces/_helia_ipns.index.PublishOptions.html
diff --git a/interfaces/_helia_ipns.index.RepublishOptions.html b/interfaces/_helia_ipns.index.RepublishOptions.html
diff --git a/interfaces/_helia_ipns.index.ResolveDNSOptions.html b/interfaces/_helia_ipns.index.ResolveDNSOptions.html
diff --git a/interfaces/_helia_ipns.index.ResolveDnsLinkOptions.html b/interfaces/_helia_ipns.index.ResolveDnsLinkOptions.html
diff --git a/interfaces/_helia_ipns.index.ResolveOptions.html b/interfaces/_helia_ipns.index.ResolveOptions.html
diff --git a/interfaces/_helia_ipns.routing.GetOptions.html b/interfaces/_helia_ipns.routing.GetOptions.html
diff --git a/interfaces/_helia_ipns.routing.IPNSRouting.html b/interfaces/_helia_ipns.routing.IPNSRouting.html
diff --git a/interfaces/_helia_ipns.routing.PutOptions.html b/interfaces/_helia_ipns.routing.PutOptions.html
diff --git a/interfaces/_helia_json.AddOptions.html b/interfaces/_helia_json.AddOptions.html
diff --git a/interfaces/_helia_json.GetOptions.html b/interfaces/_helia_json.GetOptions.html
diff --git a/interfaces/_helia_json.JSON.html b/interfaces/_helia_json.JSON.html
diff --git a/interfaces/_helia_json.JSONComponents.html b/interfaces/_helia_json.JSONComponents.html
diff --git a/interfaces/_helia_mfs.MFS.html b/interfaces/_helia_mfs.MFS.html
diff --git a/interfaces/_helia_mfs.MFSComponents.html b/interfaces/_helia_mfs.MFSComponents.html
diff --git a/interfaces/_helia_mfs.MFSInit.html b/interfaces/_helia_mfs.MFSInit.html
diff --git a/interfaces/_helia_mfs.RmOptions.html b/interfaces/_helia_mfs.RmOptions.html
diff --git a/interfaces/_helia_strings.AddOptions.html b/interfaces/_helia_strings.AddOptions.html
diff --git a/interfaces/_helia_strings.GetOptions.html b/interfaces/_helia_strings.GetOptions.html
diff --git a/interfaces/_helia_strings.Strings.html b/interfaces/_helia_strings.Strings.html
diff --git a/interfaces/_helia_strings.StringsComponents.html b/interfaces/_helia_strings.StringsComponents.html
diff --git a/interfaces/_helia_unixfs.index.AddOptions.html b/interfaces/_helia_unixfs.index.AddOptions.html
diff --git a/interfaces/_helia_unixfs.index.CatOptions.html b/interfaces/_helia_unixfs.index.CatOptions.html
diff --git a/interfaces/_helia_unixfs.index.ChmodOptions.html b/interfaces/_helia_unixfs.index.ChmodOptions.html
diff --git a/interfaces/_helia_unixfs.index.CpOptions.html b/interfaces/_helia_unixfs.index.CpOptions.html
diff --git a/interfaces/_helia_unixfs.index.LsOptions.html b/interfaces/_helia_unixfs.index.LsOptions.html
diff --git a/interfaces/_helia_unixfs.index.MkdirOptions.html b/interfaces/_helia_unixfs.index.MkdirOptions.html
diff --git a/interfaces/_helia_unixfs.index.RmOptions.html b/interfaces/_helia_unixfs.index.RmOptions.html
diff --git a/interfaces/_helia_unixfs.index.StatOptions.html b/interfaces/_helia_unixfs.index.StatOptions.html
diff --git a/interfaces/_helia_unixfs.index.TouchOptions.html b/interfaces/_helia_unixfs.index.TouchOptions.html
diff --git a/interfaces/_helia_unixfs.index.UnixFS.html b/interfaces/_helia_unixfs.index.UnixFS.html
diff --git a/interfaces/_helia_unixfs.index.UnixFSComponents.html b/interfaces/_helia_unixfs.index.UnixFSComponents.html
diff --git a/interfaces/_helia_unixfs.index.UnixFSStats.html b/interfaces/_helia_unixfs.index.UnixFSStats.html
diff --git a/interfaces/helia.AddOptions.html b/interfaces/helia.AddOptions.html
diff --git a/interfaces/helia.index.BlockAnnouncer.html → interfaces/helia.BlockAnnouncer.html b/interfaces/helia.index.BlockAnnouncer.html → interfaces/helia.BlockAnnouncer.html
diff --git a/interfaces/helia.BlockRetriever.html b/interfaces/helia.BlockRetriever.html
diff --git a/interfaces/helia.Blocks.html b/interfaces/helia.Blocks.html
diff --git a/interfaces/helia.DAGWalker.html b/interfaces/helia.DAGWalker.html
diff --git a/interfaces/helia.DefaultLibp2pServices.html b/interfaces/helia.DefaultLibp2pServices.html
diff --git a/interfaces/helia.index.GCOptions.html → interfaces/helia.GCOptions.html b/interfaces/helia.index.GCOptions.html → interfaces/helia.GCOptions.html
diff --git a/types/helia.index.AwaitIterable.html → interfaces/helia.GetOfflineOptions.html b/types/helia.index.AwaitIterable.html → interfaces/helia.GetOfflineOptions.html
diff --git a/interfaces/helia.Helia.html b/interfaces/helia.Helia.html
diff --git a/interfaces/helia.HeliaInit.html b/interfaces/helia.HeliaInit.html
diff --git a/interfaces/helia.IsPinnedOptions.html b/interfaces/helia.IsPinnedOptions.html
diff --git a/interfaces/helia.LsOptions.html b/interfaces/helia.LsOptions.html
diff --git a/interfaces/helia.Pair.html b/interfaces/helia.Pair.html
diff --git a/interfaces/helia.Pin.html b/interfaces/helia.Pin.html
diff --git a/interfaces/helia.index.Pins.html → interfaces/helia.Pins.html b/interfaces/helia.index.Pins.html → interfaces/helia.Pins.html
diff --git a/interfaces/helia.RmOptions.html b/interfaces/helia.RmOptions.html
diff --git a/interfaces/helia.index.AddOptions.html b/interfaces/helia.index.AddOptions.html
diff --git a/interfaces/helia.index.BlockRetriever.html b/interfaces/helia.index.BlockRetriever.html
diff --git a/interfaces/helia.index.Blocks.html b/interfaces/helia.index.Blocks.html
diff --git a/interfaces/helia.index.Helia.html b/interfaces/helia.index.Helia.html
diff --git a/interfaces/helia.index.HeliaInit.html b/interfaces/helia.index.HeliaInit.html
diff --git a/interfaces/helia.index.IsPinnedOptions.html b/interfaces/helia.index.IsPinnedOptions.html
diff --git a/interfaces/helia.index.LsOptions.html b/interfaces/helia.index.LsOptions.html
diff --git a/interfaces/helia.index.Pin.html b/interfaces/helia.index.Pin.html
diff --git a/interfaces/helia.index.RmOptions.html b/interfaces/helia.index.RmOptions.html
diff --git a/modules/_helia_block_brokers.html b/modules/_helia_block_brokers.html
diff --git a/modules/_helia_car.html b/modules/_helia_car.html
diff --git a/modules/_helia_dag_cbor.html b/modules/_helia_dag_cbor.html
diff --git a/modules/_helia_dag_json.html b/modules/_helia_dag_json.html
diff --git a/modules/_helia_interface.blocks.html b/modules/_helia_interface.blocks.html
diff --git a/modules/_helia_interface.html b/modules/_helia_interface.html
diff --git a/modules/_helia_interface.index.html b/modules/_helia_interface.index.html
diff --git a/modules/_helia_interface.pins.html b/modules/_helia_interface.pins.html
diff --git a/modules/_helia_ipns.dns_resolvers.html b/modules/_helia_ipns.dns_resolvers.html
diff --git a/modules/_helia_ipns.html b/modules/_helia_ipns.html
diff --git a/modules/_helia_ipns.index.html b/modules/_helia_ipns.index.html
diff --git a/modules/_helia_ipns.routing.html b/modules/_helia_ipns.routing.html
diff --git a/modules/_helia_json.html b/modules/_helia_json.html
diff --git a/modules/_helia_mfs.html b/modules/_helia_mfs.html
diff --git a/modules/_helia_strings.html b/modules/_helia_strings.html
diff --git a/modules/_helia_unixfs.errors.html b/modules/_helia_unixfs.errors.html
diff --git a/modules/_helia_unixfs.html b/modules/_helia_unixfs.html
diff --git a/modules/_helia_unixfs.index.html b/modules/_helia_unixfs.index.html
diff --git a/modules/helia.html b/modules/helia.html
diff --git a/modules/helia.index.html b/modules/helia.index.html
diff --git a/modules/helia.utils_default_hashers.html b/modules/helia.utils_default_hashers.html
diff --git a/types/_helia_interface.blocks.BlockBroker.html b/types/_helia_interface.blocks.BlockBroker.html
diff --git a/types/_helia_interface.blocks.BlockRetrievalOptions.html b/types/_helia_interface.blocks.BlockRetrievalOptions.html
diff --git a/types/_helia_interface.blocks.DeleteBlockProgressEvents.html b/types/_helia_interface.blocks.DeleteBlockProgressEvents.html
diff --git a/types/_helia_interface.blocks.DeleteManyBlocksProgressEvents.html b/types/_helia_interface.blocks.DeleteManyBlocksProgressEvents.html
diff --git a/types/_helia_interface.blocks.GetAllBlocksProgressEvents.html b/types/_helia_interface.blocks.GetAllBlocksProgressEvents.html
diff --git a/types/_helia_interface.blocks.GetBlockProgressEvents.html b/types/_helia_interface.blocks.GetBlockProgressEvents.html
diff --git a/types/_helia_interface.blocks.GetManyBlocksProgressEvents.html b/types/_helia_interface.blocks.GetManyBlocksProgressEvents.html
diff --git a/types/_helia_interface.blocks.HasBlockProgressEvents.html b/types/_helia_interface.blocks.HasBlockProgressEvents.html
diff --git a/types/_helia_interface.blocks.PutBlockProgressEvents.html b/types/_helia_interface.blocks.PutBlockProgressEvents.html
diff --git a/types/_helia_interface.blocks.PutManyBlocksProgressEvents.html b/types/_helia_interface.blocks.PutManyBlocksProgressEvents.html
diff --git a/types/_helia_interface.index.Await.html b/types/_helia_interface.index.Await.html
diff --git a/types/_helia_interface.index.AwaitIterable.html b/types/_helia_interface.index.AwaitIterable.html
diff --git a/types/_helia_interface.index.GcEvents.html b/types/_helia_interface.index.GcEvents.html
diff --git a/types/_helia_interface.pins.AddPinEvents.html b/types/_helia_interface.pins.AddPinEvents.html
diff --git a/types/_helia_interface.pins.PinType.html b/types/_helia_interface.pins.PinType.html
diff --git a/types/_helia_ipns.index.PublishProgressEvents.html b/types/_helia_ipns.index.PublishProgressEvents.html
diff --git a/types/helia.index.PinType.html → ...a_ipns.index.RepublishProgressEvents.html b/types/helia.index.PinType.html → ...a_ipns.index.RepublishProgressEvents.html
diff --git a/types/helia.index.Await.html → ...s.index.ResolveDnsLinkProgressEvents.html b/types/helia.index.Await.html → ...s.index.ResolveDnsLinkProgressEvents.html
diff --git a/types/helia.index.BlockRetrievalOptions.html → ...lia_ipns.index.ResolveProgressEvents.html b/types/helia.index.BlockRetrievalOptions.html → ...lia_ipns.index.ResolveProgressEvents.html
diff --git a/types/_helia_ipns.routing.IPNSRoutingEvents.html b/types/_helia_ipns.routing.IPNSRoutingEvents.html
diff --git a/...s/helia.index.GetBlockProgressEvents.html → types/_helia_mfs.MkdirOptions.html b/...s/helia.index.GetBlockProgressEvents.html → types/_helia_mfs.MkdirOptions.html
diff --git a/types/_helia_mfs.WriteOptions.html b/types/_helia_mfs.WriteOptions.html
diff --git a/types/_helia_unixfs.index.AddEvents.html b/types/_helia_unixfs.index.AddEvents.html
diff --git a/types/_helia_unixfs.index.GetEvents.html b/types/_helia_unixfs.index.GetEvents.html
diff --git a/types/helia.AddPinEvents.html b/types/helia.AddPinEvents.html
diff --git a/interfaces/helia.index.DAGWalker.html → types/helia.Await.html b/interfaces/helia.index.DAGWalker.html → types/helia.Await.html
diff --git a/types/helia.AwaitIterable.html b/types/helia.AwaitIterable.html
diff --git a/types/helia.BlockBroker.html b/types/helia.BlockBroker.html
diff --git a/types/helia.BlockRetrievalOptions.html b/types/helia.BlockRetrievalOptions.html
diff --git a/types/helia.DeleteBlockProgressEvents.html b/types/helia.DeleteBlockProgressEvents.html
diff --git a/types/helia.DeleteManyBlocksProgressEvents.html b/types/helia.DeleteManyBlocksProgressEvents.html
diff --git a/types/helia.GcEvents.html b/types/helia.GcEvents.html
diff --git a/types/helia.GetAllBlocksProgressEvents.html b/types/helia.GetAllBlocksProgressEvents.html
diff --git a/types/helia.GetBlockProgressEvents.html b/types/helia.GetBlockProgressEvents.html
diff --git a/types/helia.GetManyBlocksProgressEvents.html b/types/helia.GetManyBlocksProgressEvents.html
diff --git a/...rfaces/helia.index.GetOfflineOptions.html → types/helia.HasBlockProgressEvents.html b/...rfaces/helia.index.GetOfflineOptions.html → types/helia.HasBlockProgressEvents.html
diff --git a/types/helia.PinType.html b/types/helia.PinType.html
diff --git a/types/helia.PutBlockProgressEvents.html b/types/helia.PutBlockProgressEvents.html
diff --git a/types/helia.PutManyBlocksProgressEvents.html b/types/helia.PutManyBlocksProgressEvents.html
diff --git a/types/helia.index.AddPinEvents.html b/types/helia.index.AddPinEvents.html
diff --git a/types/helia.index.BlockBroker.html b/types/helia.index.BlockBroker.html
diff --git a/types/helia.index.DeleteBlockProgressEvents.html b/types/helia.index.DeleteBlockProgressEvents.html
diff --git a/types/helia.index.DeleteManyBlocksProgressEvents.html b/types/helia.index.DeleteManyBlocksProgressEvents.html
diff --git a/types/helia.index.GcEvents.html b/types/helia.index.GcEvents.html
diff --git a/types/helia.index.HasBlockProgressEvents.html b/types/helia.index.HasBlockProgressEvents.html
diff --git a/types/helia.index.PutBlockProgressEvents.html b/types/helia.index.PutBlockProgressEvents.html
diff --git a/types/helia.index.PutManyBlocksProgressEvents.html b/types/helia.index.PutManyBlocksProgressEvents.html