# Table of Contents

- [Helia](#helia)
- [Helia](#helia)
- [AddOptions | Helia](#addoptions-helia)
- [Page not found · GitHub Pages](#page-not-found-github-pages)
- [Page not found · GitHub Pages](#page-not-found-github-pages)
- [Page not found · GitHub Pages](#page-not-found-github-pages)
- [Page not found · GitHub Pages](#page-not-found-github-pages)
- [Page not found · GitHub Pages](#page-not-found-github-pages)
- [Page not found · GitHub Pages](#page-not-found-github-pages)
- [Page not found · GitHub Pages](#page-not-found-github-pages)
- [Page not found · GitHub Pages](#page-not-found-github-pages)
- [Page not found · GitHub Pages](#page-not-found-github-pages)
- [PutBlockProgressEvents | Helia](#putblockprogressevents-helia)
- [Page not found · GitHub Pages](#page-not-found-github-pages)
- [Page not found · GitHub Pages](#page-not-found-github-pages)
- [@helia/dag-cbor | Helia](#-helia-dag-cbor-helia)
- [Page not found · GitHub Pages](#page-not-found-github-pages)
- [Site not found · GitHub Pages](#site-not-found-github-pages)
- [helia | Helia](#helia-helia)
- [DAGCBOR | Helia](#dagcbor-helia)
- [DAGCBORComponents | Helia](#dagcborcomponents-helia)
- [GetOptions | Helia](#getoptions-helia)
- [dagCbor | Helia](#dagcbor-helia)
- [Helia | Helia](#helia-helia)
- [InsufficientProvidersError | Helia](#insufficientproviderserror-helia)
- [NoRoutersAvailableError | Helia](#noroutersavailableerror-helia)
- [UnknownCodecError | Helia](#unknowncodecerror-helia)
- [UnknownHashAlgorithmError | Helia](#unknownhashalgorithmerror-helia)
- [BlockAnnounceOptions | Helia](#blockannounceoptions-helia)
- [AddOptions | Helia](#addoptions-helia)
- [BlockBroker | Helia](#blockbroker-helia)
- [BlockRetrievalOptions | Helia](#blockretrievaloptions-helia)
- [CodecLoader | Helia](#codecloader-helia)
- [Blocks | Helia](#blocks-helia)
- [CreateSessionOptions | Helia](#createsessionoptions-helia)
- [DAGWalker | Helia](#dagwalker-helia)
- [DefaultLibp2pServices | Helia](#defaultlibp2pservices-helia)
- [GCOptions | Helia](#gcoptions-helia)
- [GetOfflineOptions | Helia](#getofflineoptions-helia)
- [HasherLoader | Helia](#hasherloader-helia)
- [Blockstore | IPFS Stores](#blockstore-ipfs-stores)
- [HeliaInit | Helia](#heliainit-helia)
- [HeliaLibp2p | Helia](#helialibp2p-helia)
- [IsPinnedOptions | Helia](#ispinnedoptions-helia)
- [Libp2pDefaultsOptions | Helia](#libp2pdefaultsoptions-helia)
- [GetBlockProgressEvents | Helia](#getblockprogressevents-helia)
- [LsOptions | Helia](#lsoptions-helia)
- [Pair | Helia](#pair-helia)
- [Pin | Helia](#pin-helia)
- [Pins | Helia](#pins-helia)
- [Provider | Helia](#provider-helia)
- [Routing | Helia](#routing-helia)
- [RmOptions | Helia](#rmoptions-helia)
- [RoutingOptions | Helia](#routingoptions-helia)
- [SessionBlockstore | Helia](#sessionblockstore-helia)
- [AddPinEvents | Helia](#addpinevents-helia)
- [Await | Helia](#await-helia)
- [AwaitIterable | Helia](#awaititerable-helia)
- [DeleteBlockProgressEvents | Helia](#deleteblockprogressevents-helia)
- [Datastore | IPFS Stores](#datastore-ipfs-stores)
- [DeleteManyBlocksProgressEvents | Helia](#deletemanyblocksprogressevents-helia)
- [GcEvents | Helia](#gcevents-helia)
- [GetAllBlocksProgressEvents | Helia](#getallblocksprogressevents-helia)
- [GetManyBlocksProgressEvents | Helia](#getmanyblocksprogressevents-helia)
- [AbortOptions | IPFS Stores](#abortoptions-ipfs-stores)
- [HasBlockProgressEvents | Helia](#hasblockprogressevents-helia)
- [PinType | Helia](#pintype-helia)
- [PutManyBlocksProgressEvents | Helia](#putmanyblocksprogressevents-helia)
- [DEFAULT_SESSION_MIN_PROVIDERS | Helia](#default-session-min-providers-helia)
- [DEFAULT_SESSION_MAX_PROVIDERS | Helia](#default-session-max-providers-helia)
- [createHelia | Helia](#createhelia-helia)
- [Pair | IPFS Stores](#pair-ipfs-stores)
- [libp2pDefaults | Helia](#libp2pdefaults-helia)
- [IPFS Stores](#ipfs-stores)
- [interface-blockstore | IPFS Stores](#interface-blockstore-ipfs-stores)
- [Await | IPFS Stores](#await-ipfs-stores)
- [HeliaInit | Helia](#heliainit-helia)
- [AwaitIterable | IPFS Stores](#awaititerable-ipfs-stores)
- [Store | IPFS Stores](#store-ipfs-stores)
- [interface-datastore | IPFS Stores](#interface-datastore-ipfs-stores)
- [index | IPFS Stores](#index-ipfs-stores)
- [Batch | IPFS Stores](#batch-ipfs-stores)
- [interface-store | IPFS Stores](#interface-store-ipfs-stores)
- [KeyQuery | IPFS Stores](#keyquery-ipfs-stores)
- [IPFS Stores](#ipfs-stores)
- [Key | IPFS Stores](#key-ipfs-stores)
- [@helia/utils | Helia](#-helia-utils-helia)
- [key | IPFS Stores](#key-ipfs-stores)
- [KeyQueryFilter | IPFS Stores](#keyqueryfilter-ipfs-stores)
- [Pair | IPFS Stores](#pair-ipfs-stores)
- [Query | IPFS Stores](#query-ipfs-stores)
- [KeyQueryOrder | IPFS Stores](#keyqueryorder-ipfs-stores)
- [QueryFilter | IPFS Stores](#queryfilter-ipfs-stores)
- [QueryOrder | IPFS Stores](#queryorder-ipfs-stores)
- [AbortError | IPFS Stores](#aborterror-ipfs-stores)
- [CloseFailedError | IPFS Stores](#closefailederror-ipfs-stores)
- [GetFailedError | IPFS Stores](#getfailederror-ipfs-stores)
- [DeleteFailedError | IPFS Stores](#deletefailederror-ipfs-stores)
- [HasFailedError | IPFS Stores](#hasfailederror-ipfs-stores)
- [NotFoundError | IPFS Stores](#notfounderror-ipfs-stores)
- [AbstractSession | Helia](#abstractsession-helia)
- [Helia | Helia](#helia-helia)
- [OpenFailedError | IPFS Stores](#openfailederror-ipfs-stores)
- [AbstractSessionComponents | Helia](#abstractsessioncomponents-helia)
- [BlockStorage | Helia](#blockstorage-helia)
- [BlockStorageInit | Helia](#blockstorageinit-helia)
- [AbstractCreateSessionOptions | Helia](#abstractcreatesessionoptions-helia)
- [BlockstoreSessionEvents | Helia](#blockstoresessionevents-helia)
- [PutFailedError | IPFS Stores](#putfailederror-ipfs-stores)

---

# Helia

Helia
-----

[![Helia logo](https://raw.githubusercontent.com/ipfs/helia/main/assets/helia.png)](https://github.com/ipfs/helia "Helia")

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
 [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 [![codecov](https://img.shields.io/codecov/c/github/ipfs/helia.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia)
 [![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia/main.yml?branch=main&style=flat-square)](https://github.com/ipfs/helia/actions/workflows/main.yml?query=branch%3Amain)

[Helia](https://github.com/ipfs/helia)
 is a lean, modular, and modern TypeScript implementation of IPFS for the prolific JS and browser environments.

See the [Manifesto](https://github.com/ipfs/helia/wiki/Manifesto)
, the [FAQ](https://github.com/ipfs/helia/wiki/FAQ)
, and the [State of IPFS in JS blog post from October 2022](https://blog.ipfs.tech/state-of-ipfs-in-js/)
 for more info.

[🌟 Usage](#md:🌟-usage)

=========================

A quick overview of how to get different types of data in and out of your Helia node.

[🪢 Strings](#md:🪢-strings)

-----------------------------

You can use the [@helia/strings](https://www.npmjs.com/package/@helia/strings)
 module to easily add and get strings from your Helia node:

    import { createHelia } from 'helia'import { strings } from '@helia/strings'const helia = await createHelia()const s = strings(helia)const myImmutableAddress = await s.add('hello world')console.log(await s.get(myImmutableAddress))// hello world
    

[🌃 JSON](#md:🌃-json)

-----------------------

The [@helia/json](https://www.npmjs.com/package/@helia/json)
 module lets you add or get plain JS objects:

    import { createHelia } from 'helia'import { json } from '@helia/json'const helia = await createHelia()const j = json(helia)const myImmutableAddress = await j.add({ hello: 'world' })console.log(await j.get(myImmutableAddress))// { hello: 'world' }
    

[🌠 DAG-JSON](#md:🌠-dag-json)

-------------------------------

The [@helia/dag-json](https://www.npmjs.com/package/@helia/dag-json)
 allows you to store references to linked objects as [CIDs](https://docs.ipfs.tech/concepts/content-addressing)
:

    import { createHelia } from 'helia'import { dagJson } from '@helia/dag-json'const helia = await createHelia()const d = dagJson(helia)const object1 = { hello: 'world' }const myImmutableAddress1 = await d.add(object1)const object2 = { link: myImmutableAddress1 }const myImmutableAddress2 = await d.add(object2)const retrievedObject = await d.get(myImmutableAddress2)console.log(retrievedObject)// { link: CID(baguqeerasor...) }console.log(await d.get(retrievedObject.link))// { hello: 'world' }
    

[🌌 DAG-CBOR](#md:🌌-dag-cbor)

-------------------------------

[@helia/dag-cbor](https://www.npmjs.com/package/@helia/dag-cbor)
 works in a similar way to `@helia/dag-json` but stores objects using [Concise Binary Object Representation](https://cbor.io/)
:

    import { createHelia } from 'helia'import { dagCbor } from '@helia/dag-cbor'const helia = await createHelia()const d = dagCbor(helia)const object1 = { hello: 'world' }const myImmutableAddress1 = await d.add(object1)const object2 = { link: myImmutableAddress1 }const myImmutableAddress2 = await d.add(object2)const retrievedObject = await d.get(myImmutableAddress2)console.log(retrievedObject)// { link: CID(baguqeerasor...) }console.log(await d.get(retrievedObject.link))// { hello: 'world' }
    

[🔒 Custom Hasher](#md:🔒-custom-hasher)

-----------------------------------------

A [hasher](https://github.com/multiformats/js-multiformats?tab=readme-ov-file#multihash-hashers)
 is used to determine the immutable address of the content (aka the [**CID**](https://github.com/multiformats/cid?tab=readme-ov-file#what-is-it)
) being imported into helia. The default hasher used by the methods above is [sha2-256 multihash](https://github.com/multiformats/js-multiformats?tab=readme-ov-file#multihash-hashers-1)
, but others can be provided with [AddOptions](https://ipfs.github.io/helia/interfaces/_helia_dag_cbor.AddOptions.html)
. This is useful for applications that require hashers with specific properties; so in most cases keeping the default is recommended.

> **Changing the hasher will cause a different CID to be returned for the same content! In other words: the same content imported with different hashers is treated like unique content with a unique address.**

    import { createHelia } from 'helia'import { dagCbor } from '@helia/dag-cbor'import { sha512 } from 'multiformats/hashes/sha2'const helia = await createHelia()const d = dagCbor(helia)const object1 = { hello: 'world' }const cidWithSHA256 = await d.add(object1)const cidWithSHA512 = await d.add(object1, {  hasher: sha512})/** The same objects with different CIDs are treated as different objects */console.log(cidWithSHA256)// CID(bafyreidykglsfhoixmivffc5uwhcgshx4j465xwqntbmu43nb2dzqwfvae)console.log(cidWithSHA512)// CID(bafyrgqhai26anf3i7pips7q22coa4sz2fr4gk4q4sqdtymvvjyginfzaqewveaeqdh524nsktaq43j65v22xxrybrtertmcfxufdam3da3hbk)const retrievedObject1 = await d.get(cidWithSHA256)const retrievedObject2 = await d.get(cidWithSHA512)console.log(retrievedObject1)// { hello: 'world' }console.log(retrievedObject2)// { hello: 'world' }
    

[🐾 Next steps](#md:🐾-next-steps)

===================================

Check out the [helia-examples](https://github.com/ipfs-examples/helia-examples)
 repo for how to do mostly anything with your Helia node.

[🏃‍♀️ Getting Started](#md:🏃♀️-getting-started)

==================================================

Check out the [Helia examples repo](https://github.com/ipfs-examples/helia-examples#examples)
, which covers a wide variety of use cases. If you feel something has been missed, follow the [contribution guide](https://github.com/ipfs-examples/helia-examples#contributing)
 and create a PR to the examples repo.

[📗 Project Docs](#md:📗-project-docs)

=======================================

*   See the [project wiki](https://github.com/ipfs/helia/wiki)
    .

[📒 API Docs](#md:📒-api-docs)

===============================

*   [https://ipfs.github.io/helia](https://ipfs.github.io/helia)
    

[📐 System diagram](#md:📐-system-diagram)

===========================================

    graph TD;    User["User or application"]-->IPNS["@helia/ipns"];    User-->UnixFS["@helia/unixfs"];    User-->Libp2p;    User-->Datastore;    User-->Blockstore;    UnixFS-->Blockstore;    IPNS-->Datastore;    subgraph helia [Helia]      Datastore      Blockstore-->BlockBrokers;      BlockBrokers-->Bitswap;      BlockBrokers-->TrustlessGateways;      Libp2p-->DHT;      Libp2p-->PubSub;      Libp2p-->IPNI;      Libp2p-->Reframe;    end    Blockstore-->BlockStorage["File system/IDB/S3/etc"];    Datastore-->DataStorage["Level/S3/IDB/etc"];    Bitswap-->Network;    TrustlessGateways-->Gateway1;    TrustlessGateways-->GatewayN;    DHT-->Network;    PubSub-->Network;    IPNI-->Network;    Reframe-->Network;
    

[🏭 Code Structure](#md:🏭-code-structure)

===========================================

Helia embraces a modular approach and encourages users to bring their own implementations of various APIs to suit their needs.

The basic Helia API is defined in:

*   [`/packages/interface`](./packages/interface)
     The Helia API

The API is implemented by:

*   [`/packages/helia`](./packages/helia)
     An peer to peer implementation that uses [bitswap](https://docs.ipfs.tech/concepts/bitswap/)
    , [libp2p](https://www.npmjs.com/package/libp2p)
     and [HTTP gateways](https://docs.ipfs.tech/reference/http/gateway/)
     as fallback
*   [`/packages/http`](./packages/http)
     A lightweight implementation that uses [HTTP gateways](https://docs.ipfs.tech/reference/http/gateway/)
     exclusively

Helia also ships a number of supplemental libraries and tools that can be combined with Helia API implementations to accomplish tasks in distributed and trustless ways.

These libraries are not intended to be the "one true implementation" of any given API, but are made available for users to include depending on the need of their particular application:

*   [./packages/car](./packages/car)
     The `@helia/car` module
*   [./packages/dag-cbor](./packages/dag-cbor)
     The `@helia/dag-cbor` module
*   [./packages/dag-json](./packages/dag-json)
     The `@helia/dag-json` module
*   [./packages/ipns](./packages/ipns)
     The `@helia/ipns` module
*   [./packages/json](./packages/json)
     The `@helia/json` module
*   [./packages/mfs](./packages/mfs)
     The `@helia/mfs` module
*   [./packages/strings](./packages/strings)
     The `@helia/strings` module
*   [./packages/unixfs](./packages/unixfs)
     The `@helia/unixfs` module

An interop suite ensures everything is compatible:

*   [`/packages/interop`](./packages/interop)
     Interop tests for Helia

[Other modules](#md:other-modules)

-----------------------------------

There are several other modules available outside this repo:

*   [`@helia/verified-fetch`](https://github.com/ipfs/helia-verified-fetch)
     A [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
    \-like API for retrieving trustless, verified content from the distributed web
*   [`@helia/delegated-routing-v1-http-api`](https://github.com/ipfs/helia-delegated-routing-v1-http-api)
     An implementation of the [Delegated Routing v1 HTTP API](https://specs.ipfs.tech/routing/http-routing-v1/)
     including a server and a client
*   [Helia WNFS](https://github.com/shovelers/helia-wnfs)
     a [WNFS](https://guide.fission.codes/developers/webnative/file-system-wnfs)
     implementation built on top of Helia
*   [`@helia/remote-pinning`](https://github.com/ipfs/helia-remote-pinning)
     A Helia client for communicating with [IPFS Pinning Services](https://ipfs.github.io/pinning-services-api-spec/)
    
*   [`@helia/http-gateway`](https://github.com/ipfs/helia-http-gateway)
     An implementation of the [IPFS HTTP Gateway API](https://docs.ipfs.tech/concepts/ipfs-gateway/#gateway-types)
     built with Helia

[📣 Project status](#md:📣-project-status)

===========================================

Helia v1 shipped in 202303 (see [releases](https://github.com/ipfs/helia/releases)
), and development keeps on trucking as we work on initiatives in the [roadmap](#md:roadmap)
 and make performance improvements and bug fixes along the way.

[Release Process](#md:release-process)

---------------------------------------

For information about our release process, please see our [release process wiki](https://github.com/ipfs/helia/wiki/Development-and-Release-Process#how-helia-is-released)
.

[🛣️ Roadmap](#md:🛣️-roadmap)

===============================

Please find and comment on [the Roadmap here](https://github.com/ipfs/helia/issues/5)
.

[👫 Get involved](#md:👫-get-involved)

=======================================

*   Watch our Helia Demo Day presentations [here](https://www.youtube.com/playlist?list=PLuhRWgmPaHtQAnt8INOe5-kV9TLVaUJ9v)
    
*   We are sharing about the progress at periodic [Helia Demos](https://lu.ma/helia)
    . This is a good place to find out the latest and learn of ways to get involved. We'd love to see you there!
*   Pick up one of the [issues](https://github.com/ipfs/helia/issues)
    .
*   Come chat in Filecoin Slack #ip-js. (Yes, we should bridge this to other chat environments. Please comment [here](https://github.com/ipfs/helia/issues/33)
     if you'd like this.)

[🤲 Contribute](#md:🤲-contribute)

===================================

Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia/issues)
.

Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md)
 for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md)
.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

[🛍️ Notable Consumers/Users](#md:🛍️-notable-consumersusers)

==============================================================

*   See [Projects using Helia](https://github.com/ipfs/helia/wiki/Projects-using-Helia)
    .

[🌞 Branding](#md:🌞-branding)

===============================

*   See [Branding](https://github.com/ipfs/helia/wiki/Branding)
    .

[🪪 License](#md:🪪-license)

=============================

Licensed under either of

*   Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/helia/blob/main/LICENSE-APACHE)
     / [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
    )
*   MIT ([LICENSE-MIT](https://github.com/ipfs/helia/blob/main/LICENSE-MIT)
     / [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)
    )

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[🌟 Usage](#md:🌟-usage)

*   [🪢 Strings](#md:🪢-strings)
    
*   [🌃 JSON](#md:🌃-json)
    
*   [🌠 DAG-JSON](#md:🌠-dag-json)
    
*   [🌌 DAG-CBOR](#md:🌌-dag-cbor)
    
*   [🔒 Custom Hasher](#md:🔒-custom-hasher)
    

[🐾 Next steps](#md:🐾-next-steps)
[🏃‍♀️ Getting Started](#md:🏃♀️-getting-started)
[📗 Project Docs](#md:📗-project-docs)
[📒 API Docs](#md:📒-api-docs)
[📐 System diagram](#md:📐-system-diagram)
[🏭 Code Structure](#md:🏭-code-structure)

*   [Other modules](#md:other-modules)
    

[📣 Project status](#md:📣-project-status)

*   [Release Process](#md:release-process)
    

[🛣️ Roadmap](#md:🛣️-roadmap)
[👫 Get involved](#md:👫-get-involved)
[🤲 Contribute](#md:🤲-contribute)
[🛍️ Notable Consumers/Users](#md:🛍️-notable-consumersusers)
[🌞 Branding](#md:🌞-branding)
[🪪 License](#md:🪪-license)

---

# Helia

Helia
-----

[![Helia logo](https://raw.githubusercontent.com/ipfs/helia/main/assets/helia.png)](https://github.com/ipfs/helia "Helia")

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
 [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 [![codecov](https://img.shields.io/codecov/c/github/ipfs/helia.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia)
 [![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia/main.yml?branch=main&style=flat-square)](https://github.com/ipfs/helia/actions/workflows/main.yml?query=branch%3Amain)

[Helia](https://github.com/ipfs/helia)
 is a lean, modular, and modern TypeScript implementation of IPFS for the prolific JS and browser environments.

See the [Manifesto](https://github.com/ipfs/helia/wiki/Manifesto)
, the [FAQ](https://github.com/ipfs/helia/wiki/FAQ)
, and the [State of IPFS in JS blog post from October 2022](https://blog.ipfs.tech/state-of-ipfs-in-js/)
 for more info.

[🌟 Usage](#md:🌟-usage)

=========================

A quick overview of how to get different types of data in and out of your Helia node.

[🪢 Strings](#md:🪢-strings)

-----------------------------

You can use the [@helia/strings](https://www.npmjs.com/package/@helia/strings)
 module to easily add and get strings from your Helia node:

    import { createHelia } from 'helia'import { strings } from '@helia/strings'const helia = await createHelia()const s = strings(helia)const myImmutableAddress = await s.add('hello world')console.log(await s.get(myImmutableAddress))// hello world
    

[🌃 JSON](#md:🌃-json)

-----------------------

The [@helia/json](https://www.npmjs.com/package/@helia/json)
 module lets you add or get plain JS objects:

    import { createHelia } from 'helia'import { json } from '@helia/json'const helia = await createHelia()const j = json(helia)const myImmutableAddress = await j.add({ hello: 'world' })console.log(await j.get(myImmutableAddress))// { hello: 'world' }
    

[🌠 DAG-JSON](#md:🌠-dag-json)

-------------------------------

The [@helia/dag-json](https://www.npmjs.com/package/@helia/dag-json)
 allows you to store references to linked objects as [CIDs](https://docs.ipfs.tech/concepts/content-addressing)
:

    import { createHelia } from 'helia'import { dagJson } from '@helia/dag-json'const helia = await createHelia()const d = dagJson(helia)const object1 = { hello: 'world' }const myImmutableAddress1 = await d.add(object1)const object2 = { link: myImmutableAddress1 }const myImmutableAddress2 = await d.add(object2)const retrievedObject = await d.get(myImmutableAddress2)console.log(retrievedObject)// { link: CID(baguqeerasor...) }console.log(await d.get(retrievedObject.link))// { hello: 'world' }
    

[🌌 DAG-CBOR](#md:🌌-dag-cbor)

-------------------------------

[@helia/dag-cbor](https://www.npmjs.com/package/@helia/dag-cbor)
 works in a similar way to `@helia/dag-json` but stores objects using [Concise Binary Object Representation](https://cbor.io/)
:

    import { createHelia } from 'helia'import { dagCbor } from '@helia/dag-cbor'const helia = await createHelia()const d = dagCbor(helia)const object1 = { hello: 'world' }const myImmutableAddress1 = await d.add(object1)const object2 = { link: myImmutableAddress1 }const myImmutableAddress2 = await d.add(object2)const retrievedObject = await d.get(myImmutableAddress2)console.log(retrievedObject)// { link: CID(baguqeerasor...) }console.log(await d.get(retrievedObject.link))// { hello: 'world' }
    

[🔒 Custom Hasher](#md:🔒-custom-hasher)

-----------------------------------------

A [hasher](https://github.com/multiformats/js-multiformats?tab=readme-ov-file#multihash-hashers)
 is used to determine the immutable address of the content (aka the [**CID**](https://github.com/multiformats/cid?tab=readme-ov-file#what-is-it)
) being imported into helia. The default hasher used by the methods above is [sha2-256 multihash](https://github.com/multiformats/js-multiformats?tab=readme-ov-file#multihash-hashers-1)
, but others can be provided with [AddOptions](https://ipfs.github.io/helia/interfaces/_helia_dag_cbor.AddOptions.html)
. This is useful for applications that require hashers with specific properties; so in most cases keeping the default is recommended.

> **Changing the hasher will cause a different CID to be returned for the same content! In other words: the same content imported with different hashers is treated like unique content with a unique address.**

    import { createHelia } from 'helia'import { dagCbor } from '@helia/dag-cbor'import { sha512 } from 'multiformats/hashes/sha2'const helia = await createHelia()const d = dagCbor(helia)const object1 = { hello: 'world' }const cidWithSHA256 = await d.add(object1)const cidWithSHA512 = await d.add(object1, {  hasher: sha512})/** The same objects with different CIDs are treated as different objects */console.log(cidWithSHA256)// CID(bafyreidykglsfhoixmivffc5uwhcgshx4j465xwqntbmu43nb2dzqwfvae)console.log(cidWithSHA512)// CID(bafyrgqhai26anf3i7pips7q22coa4sz2fr4gk4q4sqdtymvvjyginfzaqewveaeqdh524nsktaq43j65v22xxrybrtertmcfxufdam3da3hbk)const retrievedObject1 = await d.get(cidWithSHA256)const retrievedObject2 = await d.get(cidWithSHA512)console.log(retrievedObject1)// { hello: 'world' }console.log(retrievedObject2)// { hello: 'world' }
    

[🐾 Next steps](#md:🐾-next-steps)

===================================

Check out the [helia-examples](https://github.com/ipfs-examples/helia-examples)
 repo for how to do mostly anything with your Helia node.

[🏃‍♀️ Getting Started](#md:🏃♀️-getting-started)

==================================================

Check out the [Helia examples repo](https://github.com/ipfs-examples/helia-examples#examples)
, which covers a wide variety of use cases. If you feel something has been missed, follow the [contribution guide](https://github.com/ipfs-examples/helia-examples#contributing)
 and create a PR to the examples repo.

[📗 Project Docs](#md:📗-project-docs)

=======================================

*   See the [project wiki](https://github.com/ipfs/helia/wiki)
    .

[📒 API Docs](#md:📒-api-docs)

===============================

*   [https://ipfs.github.io/helia](https://ipfs.github.io/helia)
    

[📐 System diagram](#md:📐-system-diagram)

===========================================

    graph TD;    User["User or application"]-->IPNS["@helia/ipns"];    User-->UnixFS["@helia/unixfs"];    User-->Libp2p;    User-->Datastore;    User-->Blockstore;    UnixFS-->Blockstore;    IPNS-->Datastore;    subgraph helia [Helia]      Datastore      Blockstore-->BlockBrokers;      BlockBrokers-->Bitswap;      BlockBrokers-->TrustlessGateways;      Libp2p-->DHT;      Libp2p-->PubSub;      Libp2p-->IPNI;      Libp2p-->Reframe;    end    Blockstore-->BlockStorage["File system/IDB/S3/etc"];    Datastore-->DataStorage["Level/S3/IDB/etc"];    Bitswap-->Network;    TrustlessGateways-->Gateway1;    TrustlessGateways-->GatewayN;    DHT-->Network;    PubSub-->Network;    IPNI-->Network;    Reframe-->Network;
    

[🏭 Code Structure](#md:🏭-code-structure)

===========================================

Helia embraces a modular approach and encourages users to bring their own implementations of various APIs to suit their needs.

The basic Helia API is defined in:

*   [`/packages/interface`](./packages/interface)
     The Helia API

The API is implemented by:

*   [`/packages/helia`](./packages/helia)
     An peer to peer implementation that uses [bitswap](https://docs.ipfs.tech/concepts/bitswap/)
    , [libp2p](https://www.npmjs.com/package/libp2p)
     and [HTTP gateways](https://docs.ipfs.tech/reference/http/gateway/)
     as fallback
*   [`/packages/http`](./packages/http)
     A lightweight implementation that uses [HTTP gateways](https://docs.ipfs.tech/reference/http/gateway/)
     exclusively

Helia also ships a number of supplemental libraries and tools that can be combined with Helia API implementations to accomplish tasks in distributed and trustless ways.

These libraries are not intended to be the "one true implementation" of any given API, but are made available for users to include depending on the need of their particular application:

*   [./packages/car](./packages/car)
     The `@helia/car` module
*   [./packages/dag-cbor](./packages/dag-cbor)
     The `@helia/dag-cbor` module
*   [./packages/dag-json](./packages/dag-json)
     The `@helia/dag-json` module
*   [./packages/ipns](./packages/ipns)
     The `@helia/ipns` module
*   [./packages/json](./packages/json)
     The `@helia/json` module
*   [./packages/mfs](./packages/mfs)
     The `@helia/mfs` module
*   [./packages/strings](./packages/strings)
     The `@helia/strings` module
*   [./packages/unixfs](./packages/unixfs)
     The `@helia/unixfs` module

An interop suite ensures everything is compatible:

*   [`/packages/interop`](./packages/interop)
     Interop tests for Helia

[Other modules](#md:other-modules)

-----------------------------------

There are several other modules available outside this repo:

*   [`@helia/verified-fetch`](https://github.com/ipfs/helia-verified-fetch)
     A [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
    \-like API for retrieving trustless, verified content from the distributed web
*   [`@helia/delegated-routing-v1-http-api`](https://github.com/ipfs/helia-delegated-routing-v1-http-api)
     An implementation of the [Delegated Routing v1 HTTP API](https://specs.ipfs.tech/routing/http-routing-v1/)
     including a server and a client
*   [Helia WNFS](https://github.com/shovelers/helia-wnfs)
     a [WNFS](https://guide.fission.codes/developers/webnative/file-system-wnfs)
     implementation built on top of Helia
*   [`@helia/remote-pinning`](https://github.com/ipfs/helia-remote-pinning)
     A Helia client for communicating with [IPFS Pinning Services](https://ipfs.github.io/pinning-services-api-spec/)
    
*   [`@helia/http-gateway`](https://github.com/ipfs/helia-http-gateway)
     An implementation of the [IPFS HTTP Gateway API](https://docs.ipfs.tech/concepts/ipfs-gateway/#gateway-types)
     built with Helia

[📣 Project status](#md:📣-project-status)

===========================================

Helia v1 shipped in 202303 (see [releases](https://github.com/ipfs/helia/releases)
), and development keeps on trucking as we work on initiatives in the [roadmap](#md:roadmap)
 and make performance improvements and bug fixes along the way.

[Release Process](#md:release-process)

---------------------------------------

For information about our release process, please see our [release process wiki](https://github.com/ipfs/helia/wiki/Development-and-Release-Process#how-helia-is-released)
.

[🛣️ Roadmap](#md:🛣️-roadmap)

===============================

Please find and comment on [the Roadmap here](https://github.com/ipfs/helia/issues/5)
.

[👫 Get involved](#md:👫-get-involved)

=======================================

*   Watch our Helia Demo Day presentations [here](https://www.youtube.com/playlist?list=PLuhRWgmPaHtQAnt8INOe5-kV9TLVaUJ9v)
    
*   We are sharing about the progress at periodic [Helia Demos](https://lu.ma/helia)
    . This is a good place to find out the latest and learn of ways to get involved. We'd love to see you there!
*   Pick up one of the [issues](https://github.com/ipfs/helia/issues)
    .
*   Come chat in Filecoin Slack #ip-js. (Yes, we should bridge this to other chat environments. Please comment [here](https://github.com/ipfs/helia/issues/33)
     if you'd like this.)

[🤲 Contribute](#md:🤲-contribute)

===================================

Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia/issues)
.

Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md)
 for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md)
.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

[🛍️ Notable Consumers/Users](#md:🛍️-notable-consumersusers)

==============================================================

*   See [Projects using Helia](https://github.com/ipfs/helia/wiki/Projects-using-Helia)
    .

[🌞 Branding](#md:🌞-branding)

===============================

*   See [Branding](https://github.com/ipfs/helia/wiki/Branding)
    .

[🪪 License](#md:🪪-license)

=============================

Licensed under either of

*   Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/helia/blob/main/LICENSE-APACHE)
     / [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
    )
*   MIT ([LICENSE-MIT](https://github.com/ipfs/helia/blob/main/LICENSE-MIT)
     / [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)
    )

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[🌟 Usage](#md:🌟-usage)

*   [🪢 Strings](#md:🪢-strings)
    
*   [🌃 JSON](#md:🌃-json)
    
*   [🌠 DAG-JSON](#md:🌠-dag-json)
    
*   [🌌 DAG-CBOR](#md:🌌-dag-cbor)
    
*   [🔒 Custom Hasher](#md:🔒-custom-hasher)
    

[🐾 Next steps](#md:🐾-next-steps)
[🏃‍♀️ Getting Started](#md:🏃♀️-getting-started)
[📗 Project Docs](#md:📗-project-docs)
[📒 API Docs](#md:📒-api-docs)
[📐 System diagram](#md:📐-system-diagram)
[🏭 Code Structure](#md:🏭-code-structure)

*   [Other modules](#md:other-modules)
    

[📣 Project status](#md:📣-project-status)

*   [Release Process](#md:release-process)
    

[🛣️ Roadmap](#md:🛣️-roadmap)
[👫 Get involved](#md:👫-get-involved)
[🤲 Contribute](#md:🤲-contribute)
[🛍️ Notable Consumers/Users](#md:🛍️-notable-consumersusers)
[🌞 Branding](#md:🌞-branding)
[🪪 License](#md:🪪-license)

---

# AddOptions | Helia

*   [Helia](../index.html)
    
*   [@helia/dag-cbor](../modules/_helia_dag_cbor.html)
    
*   [AddOptions](_helia_dag_cbor.AddOptions.html)
    

Interface AddOptions
====================

interface AddOptions {  
    [hasher](_helia_dag_cbor.AddOptions.html#hasher)
: [MultihashHasher](https://multiformats.github.io/js-multiformats/interfaces/hashes_interface.MultihashHasher.html)
<number\>;  
    [onProgress](_helia_dag_cbor.AddOptions.html#onProgress)
?: ((evt) => void);  
    [signal](_helia_dag_cbor.AddOptions.html#signal)
?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)
;  
}

#### Hierarchy

*   [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
    
*   [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[PutBlockProgressEvents](../types/helia.PutBlockProgressEvents.html)
    \>
    *   AddOptions

##### Index

### Properties

[hasher](_helia_dag_cbor.AddOptions.html#hasher)
 [onProgress?](_helia_dag_cbor.AddOptions.html#onProgress)
 [signal?](_helia_dag_cbor.AddOptions.html#signal)

Properties
----------

### hasher[](#hasher)

hasher: [MultihashHasher](https://multiformats.github.io/js-multiformats/interfaces/hashes_interface.MultihashHasher.html)
<number\>

### `Optional` onProgress[](#onProgress)

onProgress?: ((evt) => void)

#### Type declaration

*   *   (evt): void
    *   #### Parameters
        
        *   evt: [PutBlockProgressEvents](../types/helia.PutBlockProgressEvents.html)
            
        
        #### Returns void
        

### `Optional` signal[](#signal)

signal?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[hasher](#hasher)
[onProgress](#onProgress)
[signal](#signal)

---

# Page not found · GitHub Pages

404
===

**File not found**

The site configured at this address does not contain the requested file.

If this is your site, make sure that the filename case matches the URL as well as any file permissions.  
For root URLs (like `http://example.com/`) you must provide an `index.html` file.

[Read the full documentation](https://help.github.com/pages/)
 for more information about using **GitHub Pages**.

[GitHub Status](https://githubstatus.com)
 — [@githubstatus](https://twitter.com/githubstatus)

 [![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTZCRDY3REIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTZCRDY3RUIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdCQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjdDQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+SM9MCAAAA+5JREFUeNrEV11Ik1EY3s4+ddOp29Q5b0opCgKFsoKoi5Kg6CIhuwi6zLJLoYLopq4qsKKgi4i6CYIoU/q5iDAKs6syoS76IRWtyJ+p7cdt7sf1PGOD+e0c3dygAx/67ZzzPM95/877GYdHRg3ZjMXFxepQKNS6sLCwJxqNNuFpiMfjVs4ZjUa/pmmjeD6VlJS8NpvNT4QQ7mxwjSsJiEQim/1+/9lgMHgIr5ohuxG1WCw9Vqv1clFR0dCqBODElV6v90ogEDjGdYbVjXhpaendioqK07CIR7ZAqE49PT09BPL2PMgTByQGsYiZlQD4uMXtdr+JxWINhgINYhGT2MsKgMrm2dnZXgRXhaHAg5jEJodUAHxux4LudHJE9RdEdA+i3Juz7bGHe4mhE9FNrgwBCLirMFV9Okh5eflFh8PR5nK5nDabrR2BNJlKO0T35+Li4n4+/J+/JQCxhmu5h3uJoXNHPbmWZAHMshWB8l5/ipqammaAf0zPDDx1ONV3vurdidqwAQL+pEc8sLcAe1CCvQ3YHxIW8Pl85xSWNC1hADDIv0rIE/o4J0k3kww4xSlwIhcq3EFFOm7KN/hUGOQkt0CFa5WpNJlMvxBEz/IVQAxg/ZRZl9wiHA63yDYieM7DnLP5CiAGsC7I5sgtYKJGWe2A8seFqgFJrJjEPY1Cn3pJ8/9W1e5VWsFDTEmFrBcoDhZJEQkXuhICMyKpjhahqN21hRYATKfUOlDmkygrR4o4C0VOLGJKrOITKB4jijzdXygBKixyC5TDQdnk/Pz8qRw6oOWGlsTKGOQW6OH6FBWsyePxdOXLTgxiyebILZCjz+GLgMIKnXNzc49YMlcRdHXcSwxFVgTInQhC9G33UhNoJLuqq6t345p9y3eUy8OTk5PjAHuI9uo4b07FBaOhsu0A4Unc+T1TU1Nj3KsSSE5yJ65jqF2DDd8QqWYmAZrIM2VlZTdnZmb6AbpdV9V6ec9znf5Q7HjYumdRE0JOp3MjitO4SFa+cZz8Umqe3TCbSLvdfkR/kWDdNQl5InuTcysOcpFT35ZrbBxx4p3JAHlZVVW1D/634VRt+FvLBgK/v5LV9WS+10xMTEwtRw7XvqOL+e2Q8V3AYIOIAXQ26/heWVnZCVfcyKHg2CBgTpmPmjYM8l24GyaUHyaIh7XwfR9ErE8qHoDfn2LTNAVC0HX6MFcBIP8Bi+6F6cdW/DICkANRfx99fEYFQ7Nph5i/uQiA214gno7K+guhaiKg9gC62+M8eR7XsBsYJ4ilam60Fb7r7uAj8wFyuwM1oIOWgfmDy6RXEEQzJMPe23DXrVS7rtyD3Df8z/FPgAEAzWU5Ku59ZAUAAAAASUVORK5CYII=)](/)
[![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpEQUM1QkUxRUI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpEQUM1QkUxRkI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdGQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjgwQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+hfPRaQAAB6lJREFUeNrsW2mME2UYbodtt+2222u35QheoCCYGBQligIJgkZJNPzgigoaTEj8AdFEMfADfyABkgWiiWcieK4S+QOiHAYUj2hMNKgYlEujpNttu9vttbvdw+chU1K6M535pt3ubHCSyezR+b73eb73+t7vrfXsufOW4bz6+vom9/b23ovnNNw34b5xYGAgODg46Mbt4mesVmsWd1qSpHhdXd2fuP/Afcput5/A88xwymcdBgLqenp6FuRyuWV4zu/v759QyWBjxoz5t76+/gun09mK5xFyakoCAPSaTCazNpvNPoYVbh6O1YKGRF0u13sNDQ27QMzfpiAAKj0lnU6/gBVfAZW2WWpwwVzy0IgP3G73FpjI6REhAGA9qVRqA1b9mVoBVyIC2tDi8Xg24+dUzQiAbS/s7Ox8G2o/3mKCC+Zw0efzPQEfcVjYrARX3dbV1bUtHo8fMgt42f+Mp0yUTVQbdWsAHVsikdiHkHaPxcQXQufXgUBgMRxme9U0AAxfH4vFvjM7eF6UkbJS5qoQwEQGA57Ac5JllFyUVZZ5ckUEgMVxsK2jlSYzI+QXJsiyjzNEAJyJAzb/KQa41jJKL8pODMQiTEAymXw5n8/P0IjD3bh7Rgog59aanxiIRTVvV/oj0tnHca/WMrVwODwB3raTGxzkBg/gnZVapFV62Wy2n5AO70HM/5wbJ0QnXyQSaVPDIuNZzY0V3ntHMwxiwHA0Gj2Np7ecIBDgaDAYXKCQJM1DhrgJ3nhulcPbl8j4NmHe46X/g60fwbz3aewjkqFQaAqebWU1AOqyQwt8Id6qEHMc97zu7u7FGGsn7HAiVuosVw7P35C1nccdgSCxop1dHeZswmfHMnxBo6ZTk+jN8dl/vF7vWofDsa+MLN9oEUBMxOb3+1eoEsBVw6Zmua49r8YmhAKDiEPcMwBsxMiqQ+ixzPFxZyqRpXARG/YOr1ObFJ0gUskXBbamcR1OKmMUvDxHRAu8/LmY3jFLMUpFqz9HxG65smYJdyKyECOxDiEAe/p1gjF2oonivZAsxVgl2daa4EQWCW6J55qFAFFZiJWYLxNQy2qOSUzGRsyXCUDIeliwAHEO4WSlWQBRFoZakXcKmCXmyXAKs0Ve9vl8q42WoIYpJU4hV3hKcNs8m9gl7p/xQ73eF5kB4j5mNrWmTJRNwAzqiV1CxjVTZCIkEq+Z1bZFZSN2CenmVAFVy4Plz8xKAGWjjAKFk6lCBMDR/MJjLLMSQNm43xAiQKTaA+9/wewhDjL+JVI1kkTSSOTcKbMTwPqESAot6dn6Fr1gHwVJju6IRuyiByPuUUBAg5DGkAgBmxlvdgIEK9gDkohdY/BJo4CAG0R8miRSsGABkgVQs4KXu098IgUXSSRsFAoKZiVAVDY2WUiiPTjYRi41KwGisrGsLtlsth8Fiwnz2fBkQvWfRtlE3iF2yW63/yCacXZ1dW02GwGyTFaRd4idJnCKHRaCxYRHoG5LTKT6SyiToP1fJHbmAYPYRR0UnZQtMnA6s0zg+GZBlt0Gdo7EPHgpE3Q6nZ8YyLhc8Xj8MJh/aKTAY+5FPAKHLE7RdwuYJZmNwzyCMkBCYyKROJBMJl9B/PXXCjjmCmDOVzH3fiPpObEWGqoKe4EBl8v1hlqsdLvd23mkxHM9pc9kMpmno9HoeTii7ewbHEZPPx1ztLS1tV3AnGuMjiNjvbQFuHw6zDo5By7dTPAQNBgMLrRarTkSls1mnwT7uwp9virx9QzbW/HuV/j5d/b+6jniKlllP8lkeONJDk+dq9GsQTnC4fB1heO0K47Hwe7WdDr9nAKgXwOBwHI+C45Htj1d6sd429TUNEcmUdc+PRaLHcvn87dXW4ugzdsaGxufL94NFv9zi1J7GVbhlvb2dnaJ3SVrxfc+n2+NTsZ7/H7/Mr3g5XdSIHyJSH1PZ+7fToyl2+ErqilgZ4NaLYB9goVGaHjR93Hv1ZrU4XDsFT20kH3PObzbWk0CgG1jacVIUnAQb9F+VexyLMzkpcLv0IJV7AHQIOCAUYHx7v5qgScmYHtTqSAyZLEJTK22Bie4iq3xsqpm4SAf9Hq9a2DnJ4uLK3SEULcdRvp3i3zHySqpficxEdsQc1NrlYXXvR+O7qASSezXB+h1SuUomgg9LL8BUoV4749EIolKh+EiqWmqVEZlDgHks2pxHw7xTqUQw9J5NcAXOK10AGIoZ6Zli6JY6Z1Q461KoZ4NiKLHarW+KDsxlDUPHZ5zPQZqUVDPJsTqb5n9malbpAh8C2XXDLl62+WZIDFRUlNVOiwencnNU3aQEkL+cDMSoLvZo2fQB7AJssNAuFuvorlDVVkkg2I87+jo2K2QAVphDrfyViK5VqtO34OkaxXCp+7drdDBCAdubm6eidX+2WwqT5komwh4YQLk+H4aE93h8Xg2gvHekQZOGSgLZTLyDTLJ4Lx9/KZWKBSainT4Iy3FqQBfnUZR42PKQFksBr9QKVXCPusD3OiA/RkQ5kP8qV/Jl1WywAp/6+dcmPM2zL1UrUahe4JqfnWWKXIul3uUbfP8njAFLW1OFr3gdFtZ72cNH+PtQT7/brW+NXqJAHh0y9V8/U/A1U7AfwIMAD7mS3pCbuWJAAAAAElFTkSuQmCC)](/)

---

# Page not found · GitHub Pages

404
===

**File not found**

The site configured at this address does not contain the requested file.

If this is your site, make sure that the filename case matches the URL as well as any file permissions.  
For root URLs (like `http://example.com/`) you must provide an `index.html` file.

[Read the full documentation](https://help.github.com/pages/)
 for more information about using **GitHub Pages**.

[GitHub Status](https://githubstatus.com)
 — [@githubstatus](https://twitter.com/githubstatus)

 [![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTZCRDY3REIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTZCRDY3RUIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdCQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjdDQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+SM9MCAAAA+5JREFUeNrEV11Ik1EY3s4+ddOp29Q5b0opCgKFsoKoi5Kg6CIhuwi6zLJLoYLopq4qsKKgi4i6CYIoU/q5iDAKs6syoS76IRWtyJ+p7cdt7sf1PGOD+e0c3dygAx/67ZzzPM95/877GYdHRg3ZjMXFxepQKNS6sLCwJxqNNuFpiMfjVs4ZjUa/pmmjeD6VlJS8NpvNT4QQ7mxwjSsJiEQim/1+/9lgMHgIr5ohuxG1WCw9Vqv1clFR0dCqBODElV6v90ogEDjGdYbVjXhpaendioqK07CIR7ZAqE49PT09BPL2PMgTByQGsYiZlQD4uMXtdr+JxWINhgINYhGT2MsKgMrm2dnZXgRXhaHAg5jEJodUAHxux4LudHJE9RdEdA+i3Juz7bGHe4mhE9FNrgwBCLirMFV9Okh5eflFh8PR5nK5nDabrR2BNJlKO0T35+Li4n4+/J+/JQCxhmu5h3uJoXNHPbmWZAHMshWB8l5/ipqammaAf0zPDDx1ONV3vurdidqwAQL+pEc8sLcAe1CCvQ3YHxIW8Pl85xSWNC1hADDIv0rIE/o4J0k3kww4xSlwIhcq3EFFOm7KN/hUGOQkt0CFa5WpNJlMvxBEz/IVQAxg/ZRZl9wiHA63yDYieM7DnLP5CiAGsC7I5sgtYKJGWe2A8seFqgFJrJjEPY1Cn3pJ8/9W1e5VWsFDTEmFrBcoDhZJEQkXuhICMyKpjhahqN21hRYATKfUOlDmkygrR4o4C0VOLGJKrOITKB4jijzdXygBKixyC5TDQdnk/Pz8qRw6oOWGlsTKGOQW6OH6FBWsyePxdOXLTgxiyebILZCjz+GLgMIKnXNzc49YMlcRdHXcSwxFVgTInQhC9G33UhNoJLuqq6t345p9y3eUy8OTk5PjAHuI9uo4b07FBaOhsu0A4Unc+T1TU1Nj3KsSSE5yJ65jqF2DDd8QqWYmAZrIM2VlZTdnZmb6AbpdV9V6ec9znf5Q7HjYumdRE0JOp3MjitO4SFa+cZz8Umqe3TCbSLvdfkR/kWDdNQl5InuTcysOcpFT35ZrbBxx4p3JAHlZVVW1D/634VRt+FvLBgK/v5LV9WS+10xMTEwtRw7XvqOL+e2Q8V3AYIOIAXQ26/heWVnZCVfcyKHg2CBgTpmPmjYM8l24GyaUHyaIh7XwfR9ErE8qHoDfn2LTNAVC0HX6MFcBIP8Bi+6F6cdW/DICkANRfx99fEYFQ7Nph5i/uQiA214gno7K+guhaiKg9gC62+M8eR7XsBsYJ4ilam60Fb7r7uAj8wFyuwM1oIOWgfmDy6RXEEQzJMPe23DXrVS7rtyD3Df8z/FPgAEAzWU5Ku59ZAUAAAAASUVORK5CYII=)](/)
[![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpEQUM1QkUxRUI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpEQUM1QkUxRkI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdGQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjgwQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+hfPRaQAAB6lJREFUeNrsW2mME2UYbodtt+2222u35QheoCCYGBQligIJgkZJNPzgigoaTEj8AdFEMfADfyABkgWiiWcieK4S+QOiHAYUj2hMNKgYlEujpNttu9vttbvdw+chU1K6M535pt3ubHCSyezR+b73eb73+t7vrfXsufOW4bz6+vom9/b23ovnNNw34b5xYGAgODg46Mbt4mesVmsWd1qSpHhdXd2fuP/Afcput5/A88xwymcdBgLqenp6FuRyuWV4zu/v759QyWBjxoz5t76+/gun09mK5xFyakoCAPSaTCazNpvNPoYVbh6O1YKGRF0u13sNDQ27QMzfpiAAKj0lnU6/gBVfAZW2WWpwwVzy0IgP3G73FpjI6REhAGA9qVRqA1b9mVoBVyIC2tDi8Xg24+dUzQiAbS/s7Ox8G2o/3mKCC+Zw0efzPQEfcVjYrARX3dbV1bUtHo8fMgt42f+Mp0yUTVQbdWsAHVsikdiHkHaPxcQXQufXgUBgMRxme9U0AAxfH4vFvjM7eF6UkbJS5qoQwEQGA57Ac5JllFyUVZZ5ckUEgMVxsK2jlSYzI+QXJsiyjzNEAJyJAzb/KQa41jJKL8pODMQiTEAymXw5n8/P0IjD3bh7Rgog59aanxiIRTVvV/oj0tnHca/WMrVwODwB3raTGxzkBg/gnZVapFV62Wy2n5AO70HM/5wbJ0QnXyQSaVPDIuNZzY0V3ntHMwxiwHA0Gj2Np7ecIBDgaDAYXKCQJM1DhrgJ3nhulcPbl8j4NmHe46X/g60fwbz3aewjkqFQaAqebWU1AOqyQwt8Id6qEHMc97zu7u7FGGsn7HAiVuosVw7P35C1nccdgSCxop1dHeZswmfHMnxBo6ZTk+jN8dl/vF7vWofDsa+MLN9oEUBMxOb3+1eoEsBVw6Zmua49r8YmhAKDiEPcMwBsxMiqQ+ixzPFxZyqRpXARG/YOr1ObFJ0gUskXBbamcR1OKmMUvDxHRAu8/LmY3jFLMUpFqz9HxG65smYJdyKyECOxDiEAe/p1gjF2oonivZAsxVgl2daa4EQWCW6J55qFAFFZiJWYLxNQy2qOSUzGRsyXCUDIeliwAHEO4WSlWQBRFoZakXcKmCXmyXAKs0Ve9vl8q42WoIYpJU4hV3hKcNs8m9gl7p/xQ73eF5kB4j5mNrWmTJRNwAzqiV1CxjVTZCIkEq+Z1bZFZSN2CenmVAFVy4Plz8xKAGWjjAKFk6lCBMDR/MJjLLMSQNm43xAiQKTaA+9/wewhDjL+JVI1kkTSSOTcKbMTwPqESAot6dn6Fr1gHwVJju6IRuyiByPuUUBAg5DGkAgBmxlvdgIEK9gDkohdY/BJo4CAG0R8miRSsGABkgVQs4KXu098IgUXSSRsFAoKZiVAVDY2WUiiPTjYRi41KwGisrGsLtlsth8Fiwnz2fBkQvWfRtlE3iF2yW63/yCacXZ1dW02GwGyTFaRd4idJnCKHRaCxYRHoG5LTKT6SyiToP1fJHbmAYPYRR0UnZQtMnA6s0zg+GZBlt0Gdo7EPHgpE3Q6nZ8YyLhc8Xj8MJh/aKTAY+5FPAKHLE7RdwuYJZmNwzyCMkBCYyKROJBMJl9B/PXXCjjmCmDOVzH3fiPpObEWGqoKe4EBl8v1hlqsdLvd23mkxHM9pc9kMpmno9HoeTii7ewbHEZPPx1ztLS1tV3AnGuMjiNjvbQFuHw6zDo5By7dTPAQNBgMLrRarTkSls1mnwT7uwp9virx9QzbW/HuV/j5d/b+6jniKlllP8lkeONJDk+dq9GsQTnC4fB1heO0K47Hwe7WdDr9nAKgXwOBwHI+C45Htj1d6sd429TUNEcmUdc+PRaLHcvn87dXW4ugzdsaGxufL94NFv9zi1J7GVbhlvb2dnaJ3SVrxfc+n2+NTsZ7/H7/Mr3g5XdSIHyJSH1PZ+7fToyl2+ErqilgZ4NaLYB9goVGaHjR93Hv1ZrU4XDsFT20kH3PObzbWk0CgG1jacVIUnAQb9F+VexyLMzkpcLv0IJV7AHQIOCAUYHx7v5qgScmYHtTqSAyZLEJTK22Bie4iq3xsqpm4SAf9Hq9a2DnJ4uLK3SEULcdRvp3i3zHySqpficxEdsQc1NrlYXXvR+O7qASSezXB+h1SuUomgg9LL8BUoV4749EIolKh+EiqWmqVEZlDgHks2pxHw7xTqUQw9J5NcAXOK10AGIoZ6Zli6JY6Z1Q461KoZ4NiKLHarW+KDsxlDUPHZ5zPQZqUVDPJsTqb5n9malbpAh8C2XXDLl62+WZIDFRUlNVOiwencnNU3aQEkL+cDMSoLvZo2fQB7AJssNAuFuvorlDVVkkg2I87+jo2K2QAVphDrfyViK5VqtO34OkaxXCp+7drdDBCAdubm6eidX+2WwqT5komwh4YQLk+H4aE93h8Xg2gvHekQZOGSgLZTLyDTLJ4Lx9/KZWKBSainT4Iy3FqQBfnUZR42PKQFksBr9QKVXCPusD3OiA/RkQ5kP8qV/Jl1WywAp/6+dcmPM2zL1UrUahe4JqfnWWKXIul3uUbfP8njAFLW1OFr3gdFtZ72cNH+PtQT7/brW+NXqJAHh0y9V8/U/A1U7AfwIMAD7mS3pCbuWJAAAAAElFTkSuQmCC)](/)

---

# Page not found · GitHub Pages

404
===

**File not found**

The site configured at this address does not contain the requested file.

If this is your site, make sure that the filename case matches the URL as well as any file permissions.  
For root URLs (like `http://example.com/`) you must provide an `index.html` file.

[Read the full documentation](https://help.github.com/pages/)
 for more information about using **GitHub Pages**.

[GitHub Status](https://githubstatus.com)
 — [@githubstatus](https://twitter.com/githubstatus)

 [![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTZCRDY3REIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTZCRDY3RUIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdCQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjdDQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+SM9MCAAAA+5JREFUeNrEV11Ik1EY3s4+ddOp29Q5b0opCgKFsoKoi5Kg6CIhuwi6zLJLoYLopq4qsKKgi4i6CYIoU/q5iDAKs6syoS76IRWtyJ+p7cdt7sf1PGOD+e0c3dygAx/67ZzzPM95/877GYdHRg3ZjMXFxepQKNS6sLCwJxqNNuFpiMfjVs4ZjUa/pmmjeD6VlJS8NpvNT4QQ7mxwjSsJiEQim/1+/9lgMHgIr5ohuxG1WCw9Vqv1clFR0dCqBODElV6v90ogEDjGdYbVjXhpaendioqK07CIR7ZAqE49PT09BPL2PMgTByQGsYiZlQD4uMXtdr+JxWINhgINYhGT2MsKgMrm2dnZXgRXhaHAg5jEJodUAHxux4LudHJE9RdEdA+i3Juz7bGHe4mhE9FNrgwBCLirMFV9Okh5eflFh8PR5nK5nDabrR2BNJlKO0T35+Li4n4+/J+/JQCxhmu5h3uJoXNHPbmWZAHMshWB8l5/ipqammaAf0zPDDx1ONV3vurdidqwAQL+pEc8sLcAe1CCvQ3YHxIW8Pl85xSWNC1hADDIv0rIE/o4J0k3kww4xSlwIhcq3EFFOm7KN/hUGOQkt0CFa5WpNJlMvxBEz/IVQAxg/ZRZl9wiHA63yDYieM7DnLP5CiAGsC7I5sgtYKJGWe2A8seFqgFJrJjEPY1Cn3pJ8/9W1e5VWsFDTEmFrBcoDhZJEQkXuhICMyKpjhahqN21hRYATKfUOlDmkygrR4o4C0VOLGJKrOITKB4jijzdXygBKixyC5TDQdnk/Pz8qRw6oOWGlsTKGOQW6OH6FBWsyePxdOXLTgxiyebILZCjz+GLgMIKnXNzc49YMlcRdHXcSwxFVgTInQhC9G33UhNoJLuqq6t345p9y3eUy8OTk5PjAHuI9uo4b07FBaOhsu0A4Unc+T1TU1Nj3KsSSE5yJ65jqF2DDd8QqWYmAZrIM2VlZTdnZmb6AbpdV9V6ec9znf5Q7HjYumdRE0JOp3MjitO4SFa+cZz8Umqe3TCbSLvdfkR/kWDdNQl5InuTcysOcpFT35ZrbBxx4p3JAHlZVVW1D/634VRt+FvLBgK/v5LV9WS+10xMTEwtRw7XvqOL+e2Q8V3AYIOIAXQ26/heWVnZCVfcyKHg2CBgTpmPmjYM8l24GyaUHyaIh7XwfR9ErE8qHoDfn2LTNAVC0HX6MFcBIP8Bi+6F6cdW/DICkANRfx99fEYFQ7Nph5i/uQiA214gno7K+guhaiKg9gC62+M8eR7XsBsYJ4ilam60Fb7r7uAj8wFyuwM1oIOWgfmDy6RXEEQzJMPe23DXrVS7rtyD3Df8z/FPgAEAzWU5Ku59ZAUAAAAASUVORK5CYII=)](/)
[![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpEQUM1QkUxRUI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpEQUM1QkUxRkI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdGQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjgwQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+hfPRaQAAB6lJREFUeNrsW2mME2UYbodtt+2222u35QheoCCYGBQligIJgkZJNPzgigoaTEj8AdFEMfADfyABkgWiiWcieK4S+QOiHAYUj2hMNKgYlEujpNttu9vttbvdw+chU1K6M535pt3ubHCSyezR+b73eb73+t7vrfXsufOW4bz6+vom9/b23ovnNNw34b5xYGAgODg46Mbt4mesVmsWd1qSpHhdXd2fuP/Afcput5/A88xwymcdBgLqenp6FuRyuWV4zu/v759QyWBjxoz5t76+/gun09mK5xFyakoCAPSaTCazNpvNPoYVbh6O1YKGRF0u13sNDQ27QMzfpiAAKj0lnU6/gBVfAZW2WWpwwVzy0IgP3G73FpjI6REhAGA9qVRqA1b9mVoBVyIC2tDi8Xg24+dUzQiAbS/s7Ox8G2o/3mKCC+Zw0efzPQEfcVjYrARX3dbV1bUtHo8fMgt42f+Mp0yUTVQbdWsAHVsikdiHkHaPxcQXQufXgUBgMRxme9U0AAxfH4vFvjM7eF6UkbJS5qoQwEQGA57Ac5JllFyUVZZ5ckUEgMVxsK2jlSYzI+QXJsiyjzNEAJyJAzb/KQa41jJKL8pODMQiTEAymXw5n8/P0IjD3bh7Rgog59aanxiIRTVvV/oj0tnHca/WMrVwODwB3raTGxzkBg/gnZVapFV62Wy2n5AO70HM/5wbJ0QnXyQSaVPDIuNZzY0V3ntHMwxiwHA0Gj2Np7ecIBDgaDAYXKCQJM1DhrgJ3nhulcPbl8j4NmHe46X/g60fwbz3aewjkqFQaAqebWU1AOqyQwt8Id6qEHMc97zu7u7FGGsn7HAiVuosVw7P35C1nccdgSCxop1dHeZswmfHMnxBo6ZTk+jN8dl/vF7vWofDsa+MLN9oEUBMxOb3+1eoEsBVw6Zmua49r8YmhAKDiEPcMwBsxMiqQ+ixzPFxZyqRpXARG/YOr1ObFJ0gUskXBbamcR1OKmMUvDxHRAu8/LmY3jFLMUpFqz9HxG65smYJdyKyECOxDiEAe/p1gjF2oonivZAsxVgl2daa4EQWCW6J55qFAFFZiJWYLxNQy2qOSUzGRsyXCUDIeliwAHEO4WSlWQBRFoZakXcKmCXmyXAKs0Ve9vl8q42WoIYpJU4hV3hKcNs8m9gl7p/xQ73eF5kB4j5mNrWmTJRNwAzqiV1CxjVTZCIkEq+Z1bZFZSN2CenmVAFVy4Plz8xKAGWjjAKFk6lCBMDR/MJjLLMSQNm43xAiQKTaA+9/wewhDjL+JVI1kkTSSOTcKbMTwPqESAot6dn6Fr1gHwVJju6IRuyiByPuUUBAg5DGkAgBmxlvdgIEK9gDkohdY/BJo4CAG0R8miRSsGABkgVQs4KXu098IgUXSSRsFAoKZiVAVDY2WUiiPTjYRi41KwGisrGsLtlsth8Fiwnz2fBkQvWfRtlE3iF2yW63/yCacXZ1dW02GwGyTFaRd4idJnCKHRaCxYRHoG5LTKT6SyiToP1fJHbmAYPYRR0UnZQtMnA6s0zg+GZBlt0Gdo7EPHgpE3Q6nZ8YyLhc8Xj8MJh/aKTAY+5FPAKHLE7RdwuYJZmNwzyCMkBCYyKROJBMJl9B/PXXCjjmCmDOVzH3fiPpObEWGqoKe4EBl8v1hlqsdLvd23mkxHM9pc9kMpmno9HoeTii7ewbHEZPPx1ztLS1tV3AnGuMjiNjvbQFuHw6zDo5By7dTPAQNBgMLrRarTkSls1mnwT7uwp9virx9QzbW/HuV/j5d/b+6jniKlllP8lkeONJDk+dq9GsQTnC4fB1heO0K47Hwe7WdDr9nAKgXwOBwHI+C45Htj1d6sd429TUNEcmUdc+PRaLHcvn87dXW4ugzdsaGxufL94NFv9zi1J7GVbhlvb2dnaJ3SVrxfc+n2+NTsZ7/H7/Mr3g5XdSIHyJSH1PZ+7fToyl2+ErqilgZ4NaLYB9goVGaHjR93Hv1ZrU4XDsFT20kH3PObzbWk0CgG1jacVIUnAQb9F+VexyLMzkpcLv0IJV7AHQIOCAUYHx7v5qgScmYHtTqSAyZLEJTK22Bie4iq3xsqpm4SAf9Hq9a2DnJ4uLK3SEULcdRvp3i3zHySqpficxEdsQc1NrlYXXvR+O7qASSezXB+h1SuUomgg9LL8BUoV4749EIolKh+EiqWmqVEZlDgHks2pxHw7xTqUQw9J5NcAXOK10AGIoZ6Zli6JY6Z1Q461KoZ4NiKLHarW+KDsxlDUPHZ5zPQZqUVDPJsTqb5n9malbpAh8C2XXDLl62+WZIDFRUlNVOiwencnNU3aQEkL+cDMSoLvZo2fQB7AJssNAuFuvorlDVVkkg2I87+jo2K2QAVphDrfyViK5VqtO34OkaxXCp+7drdDBCAdubm6eidX+2WwqT5komwh4YQLk+H4aE93h8Xg2gvHekQZOGSgLZTLyDTLJ4Lx9/KZWKBSainT4Iy3FqQBfnUZR42PKQFksBr9QKVXCPusD3OiA/RkQ5kP8qV/Jl1WywAp/6+dcmPM2zL1UrUahe4JqfnWWKXIul3uUbfP8njAFLW1OFr3gdFtZ72cNH+PtQT7/brW+NXqJAHh0y9V8/U/A1U7AfwIMAD7mS3pCbuWJAAAAAElFTkSuQmCC)](/)

---

# Page not found · GitHub Pages

404
===

**File not found**

The site configured at this address does not contain the requested file.

If this is your site, make sure that the filename case matches the URL as well as any file permissions.  
For root URLs (like `http://example.com/`) you must provide an `index.html` file.

[Read the full documentation](https://help.github.com/pages/)
 for more information about using **GitHub Pages**.

[GitHub Status](https://githubstatus.com)
 — [@githubstatus](https://twitter.com/githubstatus)

 [![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTZCRDY3REIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTZCRDY3RUIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdCQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjdDQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+SM9MCAAAA+5JREFUeNrEV11Ik1EY3s4+ddOp29Q5b0opCgKFsoKoi5Kg6CIhuwi6zLJLoYLopq4qsKKgi4i6CYIoU/q5iDAKs6syoS76IRWtyJ+p7cdt7sf1PGOD+e0c3dygAx/67ZzzPM95/877GYdHRg3ZjMXFxepQKNS6sLCwJxqNNuFpiMfjVs4ZjUa/pmmjeD6VlJS8NpvNT4QQ7mxwjSsJiEQim/1+/9lgMHgIr5ohuxG1WCw9Vqv1clFR0dCqBODElV6v90ogEDjGdYbVjXhpaendioqK07CIR7ZAqE49PT09BPL2PMgTByQGsYiZlQD4uMXtdr+JxWINhgINYhGT2MsKgMrm2dnZXgRXhaHAg5jEJodUAHxux4LudHJE9RdEdA+i3Juz7bGHe4mhE9FNrgwBCLirMFV9Okh5eflFh8PR5nK5nDabrR2BNJlKO0T35+Li4n4+/J+/JQCxhmu5h3uJoXNHPbmWZAHMshWB8l5/ipqammaAf0zPDDx1ONV3vurdidqwAQL+pEc8sLcAe1CCvQ3YHxIW8Pl85xSWNC1hADDIv0rIE/o4J0k3kww4xSlwIhcq3EFFOm7KN/hUGOQkt0CFa5WpNJlMvxBEz/IVQAxg/ZRZl9wiHA63yDYieM7DnLP5CiAGsC7I5sgtYKJGWe2A8seFqgFJrJjEPY1Cn3pJ8/9W1e5VWsFDTEmFrBcoDhZJEQkXuhICMyKpjhahqN21hRYATKfUOlDmkygrR4o4C0VOLGJKrOITKB4jijzdXygBKixyC5TDQdnk/Pz8qRw6oOWGlsTKGOQW6OH6FBWsyePxdOXLTgxiyebILZCjz+GLgMIKnXNzc49YMlcRdHXcSwxFVgTInQhC9G33UhNoJLuqq6t345p9y3eUy8OTk5PjAHuI9uo4b07FBaOhsu0A4Unc+T1TU1Nj3KsSSE5yJ65jqF2DDd8QqWYmAZrIM2VlZTdnZmb6AbpdV9V6ec9znf5Q7HjYumdRE0JOp3MjitO4SFa+cZz8Umqe3TCbSLvdfkR/kWDdNQl5InuTcysOcpFT35ZrbBxx4p3JAHlZVVW1D/634VRt+FvLBgK/v5LV9WS+10xMTEwtRw7XvqOL+e2Q8V3AYIOIAXQ26/heWVnZCVfcyKHg2CBgTpmPmjYM8l24GyaUHyaIh7XwfR9ErE8qHoDfn2LTNAVC0HX6MFcBIP8Bi+6F6cdW/DICkANRfx99fEYFQ7Nph5i/uQiA214gno7K+guhaiKg9gC62+M8eR7XsBsYJ4ilam60Fb7r7uAj8wFyuwM1oIOWgfmDy6RXEEQzJMPe23DXrVS7rtyD3Df8z/FPgAEAzWU5Ku59ZAUAAAAASUVORK5CYII=)](/)
[![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpEQUM1QkUxRUI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpEQUM1QkUxRkI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdGQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjgwQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+hfPRaQAAB6lJREFUeNrsW2mME2UYbodtt+2222u35QheoCCYGBQligIJgkZJNPzgigoaTEj8AdFEMfADfyABkgWiiWcieK4S+QOiHAYUj2hMNKgYlEujpNttu9vttbvdw+chU1K6M535pt3ubHCSyezR+b73eb73+t7vrfXsufOW4bz6+vom9/b23ovnNNw34b5xYGAgODg46Mbt4mesVmsWd1qSpHhdXd2fuP/Afcput5/A88xwymcdBgLqenp6FuRyuWV4zu/v759QyWBjxoz5t76+/gun09mK5xFyakoCAPSaTCazNpvNPoYVbh6O1YKGRF0u13sNDQ27QMzfpiAAKj0lnU6/gBVfAZW2WWpwwVzy0IgP3G73FpjI6REhAGA9qVRqA1b9mVoBVyIC2tDi8Xg24+dUzQiAbS/s7Ox8G2o/3mKCC+Zw0efzPQEfcVjYrARX3dbV1bUtHo8fMgt42f+Mp0yUTVQbdWsAHVsikdiHkHaPxcQXQufXgUBgMRxme9U0AAxfH4vFvjM7eF6UkbJS5qoQwEQGA57Ac5JllFyUVZZ5ckUEgMVxsK2jlSYzI+QXJsiyjzNEAJyJAzb/KQa41jJKL8pODMQiTEAymXw5n8/P0IjD3bh7Rgog59aanxiIRTVvV/oj0tnHca/WMrVwODwB3raTGxzkBg/gnZVapFV62Wy2n5AO70HM/5wbJ0QnXyQSaVPDIuNZzY0V3ntHMwxiwHA0Gj2Np7ecIBDgaDAYXKCQJM1DhrgJ3nhulcPbl8j4NmHe46X/g60fwbz3aewjkqFQaAqebWU1AOqyQwt8Id6qEHMc97zu7u7FGGsn7HAiVuosVw7P35C1nccdgSCxop1dHeZswmfHMnxBo6ZTk+jN8dl/vF7vWofDsa+MLN9oEUBMxOb3+1eoEsBVw6Zmua49r8YmhAKDiEPcMwBsxMiqQ+ixzPFxZyqRpXARG/YOr1ObFJ0gUskXBbamcR1OKmMUvDxHRAu8/LmY3jFLMUpFqz9HxG65smYJdyKyECOxDiEAe/p1gjF2oonivZAsxVgl2daa4EQWCW6J55qFAFFZiJWYLxNQy2qOSUzGRsyXCUDIeliwAHEO4WSlWQBRFoZakXcKmCXmyXAKs0Ve9vl8q42WoIYpJU4hV3hKcNs8m9gl7p/xQ73eF5kB4j5mNrWmTJRNwAzqiV1CxjVTZCIkEq+Z1bZFZSN2CenmVAFVy4Plz8xKAGWjjAKFk6lCBMDR/MJjLLMSQNm43xAiQKTaA+9/wewhDjL+JVI1kkTSSOTcKbMTwPqESAot6dn6Fr1gHwVJju6IRuyiByPuUUBAg5DGkAgBmxlvdgIEK9gDkohdY/BJo4CAG0R8miRSsGABkgVQs4KXu098IgUXSSRsFAoKZiVAVDY2WUiiPTjYRi41KwGisrGsLtlsth8Fiwnz2fBkQvWfRtlE3iF2yW63/yCacXZ1dW02GwGyTFaRd4idJnCKHRaCxYRHoG5LTKT6SyiToP1fJHbmAYPYRR0UnZQtMnA6s0zg+GZBlt0Gdo7EPHgpE3Q6nZ8YyLhc8Xj8MJh/aKTAY+5FPAKHLE7RdwuYJZmNwzyCMkBCYyKROJBMJl9B/PXXCjjmCmDOVzH3fiPpObEWGqoKe4EBl8v1hlqsdLvd23mkxHM9pc9kMpmno9HoeTii7ewbHEZPPx1ztLS1tV3AnGuMjiNjvbQFuHw6zDo5By7dTPAQNBgMLrRarTkSls1mnwT7uwp9virx9QzbW/HuV/j5d/b+6jniKlllP8lkeONJDk+dq9GsQTnC4fB1heO0K47Hwe7WdDr9nAKgXwOBwHI+C45Htj1d6sd429TUNEcmUdc+PRaLHcvn87dXW4ugzdsaGxufL94NFv9zi1J7GVbhlvb2dnaJ3SVrxfc+n2+NTsZ7/H7/Mr3g5XdSIHyJSH1PZ+7fToyl2+ErqilgZ4NaLYB9goVGaHjR93Hv1ZrU4XDsFT20kH3PObzbWk0CgG1jacVIUnAQb9F+VexyLMzkpcLv0IJV7AHQIOCAUYHx7v5qgScmYHtTqSAyZLEJTK22Bie4iq3xsqpm4SAf9Hq9a2DnJ4uLK3SEULcdRvp3i3zHySqpficxEdsQc1NrlYXXvR+O7qASSezXB+h1SuUomgg9LL8BUoV4749EIolKh+EiqWmqVEZlDgHks2pxHw7xTqUQw9J5NcAXOK10AGIoZ6Zli6JY6Z1Q461KoZ4NiKLHarW+KDsxlDUPHZ5zPQZqUVDPJsTqb5n9malbpAh8C2XXDLl62+WZIDFRUlNVOiwencnNU3aQEkL+cDMSoLvZo2fQB7AJssNAuFuvorlDVVkkg2I87+jo2K2QAVphDrfyViK5VqtO34OkaxXCp+7drdDBCAdubm6eidX+2WwqT5komwh4YQLk+H4aE93h8Xg2gvHekQZOGSgLZTLyDTLJ4Lx9/KZWKBSainT4Iy3FqQBfnUZR42PKQFksBr9QKVXCPusD3OiA/RkQ5kP8qV/Jl1WywAp/6+dcmPM2zL1UrUahe4JqfnWWKXIul3uUbfP8njAFLW1OFr3gdFtZ72cNH+PtQT7/brW+NXqJAHh0y9V8/U/A1U7AfwIMAD7mS3pCbuWJAAAAAElFTkSuQmCC)](/)

---

# Page not found · GitHub Pages

404
===

**File not found**

The site configured at this address does not contain the requested file.

If this is your site, make sure that the filename case matches the URL as well as any file permissions.  
For root URLs (like `http://example.com/`) you must provide an `index.html` file.

[Read the full documentation](https://help.github.com/pages/)
 for more information about using **GitHub Pages**.

[GitHub Status](https://githubstatus.com)
 — [@githubstatus](https://twitter.com/githubstatus)

 [![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTZCRDY3REIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTZCRDY3RUIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdCQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjdDQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+SM9MCAAAA+5JREFUeNrEV11Ik1EY3s4+ddOp29Q5b0opCgKFsoKoi5Kg6CIhuwi6zLJLoYLopq4qsKKgi4i6CYIoU/q5iDAKs6syoS76IRWtyJ+p7cdt7sf1PGOD+e0c3dygAx/67ZzzPM95/877GYdHRg3ZjMXFxepQKNS6sLCwJxqNNuFpiMfjVs4ZjUa/pmmjeD6VlJS8NpvNT4QQ7mxwjSsJiEQim/1+/9lgMHgIr5ohuxG1WCw9Vqv1clFR0dCqBODElV6v90ogEDjGdYbVjXhpaendioqK07CIR7ZAqE49PT09BPL2PMgTByQGsYiZlQD4uMXtdr+JxWINhgINYhGT2MsKgMrm2dnZXgRXhaHAg5jEJodUAHxux4LudHJE9RdEdA+i3Juz7bGHe4mhE9FNrgwBCLirMFV9Okh5eflFh8PR5nK5nDabrR2BNJlKO0T35+Li4n4+/J+/JQCxhmu5h3uJoXNHPbmWZAHMshWB8l5/ipqammaAf0zPDDx1ONV3vurdidqwAQL+pEc8sLcAe1CCvQ3YHxIW8Pl85xSWNC1hADDIv0rIE/o4J0k3kww4xSlwIhcq3EFFOm7KN/hUGOQkt0CFa5WpNJlMvxBEz/IVQAxg/ZRZl9wiHA63yDYieM7DnLP5CiAGsC7I5sgtYKJGWe2A8seFqgFJrJjEPY1Cn3pJ8/9W1e5VWsFDTEmFrBcoDhZJEQkXuhICMyKpjhahqN21hRYATKfUOlDmkygrR4o4C0VOLGJKrOITKB4jijzdXygBKixyC5TDQdnk/Pz8qRw6oOWGlsTKGOQW6OH6FBWsyePxdOXLTgxiyebILZCjz+GLgMIKnXNzc49YMlcRdHXcSwxFVgTInQhC9G33UhNoJLuqq6t345p9y3eUy8OTk5PjAHuI9uo4b07FBaOhsu0A4Unc+T1TU1Nj3KsSSE5yJ65jqF2DDd8QqWYmAZrIM2VlZTdnZmb6AbpdV9V6ec9znf5Q7HjYumdRE0JOp3MjitO4SFa+cZz8Umqe3TCbSLvdfkR/kWDdNQl5InuTcysOcpFT35ZrbBxx4p3JAHlZVVW1D/634VRt+FvLBgK/v5LV9WS+10xMTEwtRw7XvqOL+e2Q8V3AYIOIAXQ26/heWVnZCVfcyKHg2CBgTpmPmjYM8l24GyaUHyaIh7XwfR9ErE8qHoDfn2LTNAVC0HX6MFcBIP8Bi+6F6cdW/DICkANRfx99fEYFQ7Nph5i/uQiA214gno7K+guhaiKg9gC62+M8eR7XsBsYJ4ilam60Fb7r7uAj8wFyuwM1oIOWgfmDy6RXEEQzJMPe23DXrVS7rtyD3Df8z/FPgAEAzWU5Ku59ZAUAAAAASUVORK5CYII=)](/)
[![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpEQUM1QkUxRUI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpEQUM1QkUxRkI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdGQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjgwQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+hfPRaQAAB6lJREFUeNrsW2mME2UYbodtt+2222u35QheoCCYGBQligIJgkZJNPzgigoaTEj8AdFEMfADfyABkgWiiWcieK4S+QOiHAYUj2hMNKgYlEujpNttu9vttbvdw+chU1K6M535pt3ubHCSyezR+b73eb73+t7vrfXsufOW4bz6+vom9/b23ovnNNw34b5xYGAgODg46Mbt4mesVmsWd1qSpHhdXd2fuP/Afcput5/A88xwymcdBgLqenp6FuRyuWV4zu/v759QyWBjxoz5t76+/gun09mK5xFyakoCAPSaTCazNpvNPoYVbh6O1YKGRF0u13sNDQ27QMzfpiAAKj0lnU6/gBVfAZW2WWpwwVzy0IgP3G73FpjI6REhAGA9qVRqA1b9mVoBVyIC2tDi8Xg24+dUzQiAbS/s7Ox8G2o/3mKCC+Zw0efzPQEfcVjYrARX3dbV1bUtHo8fMgt42f+Mp0yUTVQbdWsAHVsikdiHkHaPxcQXQufXgUBgMRxme9U0AAxfH4vFvjM7eF6UkbJS5qoQwEQGA57Ac5JllFyUVZZ5ckUEgMVxsK2jlSYzI+QXJsiyjzNEAJyJAzb/KQa41jJKL8pODMQiTEAymXw5n8/P0IjD3bh7Rgog59aanxiIRTVvV/oj0tnHca/WMrVwODwB3raTGxzkBg/gnZVapFV62Wy2n5AO70HM/5wbJ0QnXyQSaVPDIuNZzY0V3ntHMwxiwHA0Gj2Np7ecIBDgaDAYXKCQJM1DhrgJ3nhulcPbl8j4NmHe46X/g60fwbz3aewjkqFQaAqebWU1AOqyQwt8Id6qEHMc97zu7u7FGGsn7HAiVuosVw7P35C1nccdgSCxop1dHeZswmfHMnxBo6ZTk+jN8dl/vF7vWofDsa+MLN9oEUBMxOb3+1eoEsBVw6Zmua49r8YmhAKDiEPcMwBsxMiqQ+ixzPFxZyqRpXARG/YOr1ObFJ0gUskXBbamcR1OKmMUvDxHRAu8/LmY3jFLMUpFqz9HxG65smYJdyKyECOxDiEAe/p1gjF2oonivZAsxVgl2daa4EQWCW6J55qFAFFZiJWYLxNQy2qOSUzGRsyXCUDIeliwAHEO4WSlWQBRFoZakXcKmCXmyXAKs0Ve9vl8q42WoIYpJU4hV3hKcNs8m9gl7p/xQ73eF5kB4j5mNrWmTJRNwAzqiV1CxjVTZCIkEq+Z1bZFZSN2CenmVAFVy4Plz8xKAGWjjAKFk6lCBMDR/MJjLLMSQNm43xAiQKTaA+9/wewhDjL+JVI1kkTSSOTcKbMTwPqESAot6dn6Fr1gHwVJju6IRuyiByPuUUBAg5DGkAgBmxlvdgIEK9gDkohdY/BJo4CAG0R8miRSsGABkgVQs4KXu098IgUXSSRsFAoKZiVAVDY2WUiiPTjYRi41KwGisrGsLtlsth8Fiwnz2fBkQvWfRtlE3iF2yW63/yCacXZ1dW02GwGyTFaRd4idJnCKHRaCxYRHoG5LTKT6SyiToP1fJHbmAYPYRR0UnZQtMnA6s0zg+GZBlt0Gdo7EPHgpE3Q6nZ8YyLhc8Xj8MJh/aKTAY+5FPAKHLE7RdwuYJZmNwzyCMkBCYyKROJBMJl9B/PXXCjjmCmDOVzH3fiPpObEWGqoKe4EBl8v1hlqsdLvd23mkxHM9pc9kMpmno9HoeTii7ewbHEZPPx1ztLS1tV3AnGuMjiNjvbQFuHw6zDo5By7dTPAQNBgMLrRarTkSls1mnwT7uwp9virx9QzbW/HuV/j5d/b+6jniKlllP8lkeONJDk+dq9GsQTnC4fB1heO0K47Hwe7WdDr9nAKgXwOBwHI+C45Htj1d6sd429TUNEcmUdc+PRaLHcvn87dXW4ugzdsaGxufL94NFv9zi1J7GVbhlvb2dnaJ3SVrxfc+n2+NTsZ7/H7/Mr3g5XdSIHyJSH1PZ+7fToyl2+ErqilgZ4NaLYB9goVGaHjR93Hv1ZrU4XDsFT20kH3PObzbWk0CgG1jacVIUnAQb9F+VexyLMzkpcLv0IJV7AHQIOCAUYHx7v5qgScmYHtTqSAyZLEJTK22Bie4iq3xsqpm4SAf9Hq9a2DnJ4uLK3SEULcdRvp3i3zHySqpficxEdsQc1NrlYXXvR+O7qASSezXB+h1SuUomgg9LL8BUoV4749EIolKh+EiqWmqVEZlDgHks2pxHw7xTqUQw9J5NcAXOK10AGIoZ6Zli6JY6Z1Q461KoZ4NiKLHarW+KDsxlDUPHZ5zPQZqUVDPJsTqb5n9malbpAh8C2XXDLl62+WZIDFRUlNVOiwencnNU3aQEkL+cDMSoLvZo2fQB7AJssNAuFuvorlDVVkkg2I87+jo2K2QAVphDrfyViK5VqtO34OkaxXCp+7drdDBCAdubm6eidX+2WwqT5komwh4YQLk+H4aE93h8Xg2gvHekQZOGSgLZTLyDTLJ4Lx9/KZWKBSainT4Iy3FqQBfnUZR42PKQFksBr9QKVXCPusD3OiA/RkQ5kP8qV/Jl1WywAp/6+dcmPM2zL1UrUahe4JqfnWWKXIul3uUbfP8njAFLW1OFr3gdFtZ72cNH+PtQT7/brW+NXqJAHh0y9V8/U/A1U7AfwIMAD7mS3pCbuWJAAAAAElFTkSuQmCC)](/)

---

# Page not found · GitHub Pages

404
===

**File not found**

The site configured at this address does not contain the requested file.

If this is your site, make sure that the filename case matches the URL as well as any file permissions.  
For root URLs (like `http://example.com/`) you must provide an `index.html` file.

[Read the full documentation](https://help.github.com/pages/)
 for more information about using **GitHub Pages**.

[GitHub Status](https://githubstatus.com)
 — [@githubstatus](https://twitter.com/githubstatus)

 [![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTZCRDY3REIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTZCRDY3RUIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdCQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjdDQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+SM9MCAAAA+5JREFUeNrEV11Ik1EY3s4+ddOp29Q5b0opCgKFsoKoi5Kg6CIhuwi6zLJLoYLopq4qsKKgi4i6CYIoU/q5iDAKs6syoS76IRWtyJ+p7cdt7sf1PGOD+e0c3dygAx/67ZzzPM95/877GYdHRg3ZjMXFxepQKNS6sLCwJxqNNuFpiMfjVs4ZjUa/pmmjeD6VlJS8NpvNT4QQ7mxwjSsJiEQim/1+/9lgMHgIr5ohuxG1WCw9Vqv1clFR0dCqBODElV6v90ogEDjGdYbVjXhpaendioqK07CIR7ZAqE49PT09BPL2PMgTByQGsYiZlQD4uMXtdr+JxWINhgINYhGT2MsKgMrm2dnZXgRXhaHAg5jEJodUAHxux4LudHJE9RdEdA+i3Juz7bGHe4mhE9FNrgwBCLirMFV9Okh5eflFh8PR5nK5nDabrR2BNJlKO0T35+Li4n4+/J+/JQCxhmu5h3uJoXNHPbmWZAHMshWB8l5/ipqammaAf0zPDDx1ONV3vurdidqwAQL+pEc8sLcAe1CCvQ3YHxIW8Pl85xSWNC1hADDIv0rIE/o4J0k3kww4xSlwIhcq3EFFOm7KN/hUGOQkt0CFa5WpNJlMvxBEz/IVQAxg/ZRZl9wiHA63yDYieM7DnLP5CiAGsC7I5sgtYKJGWe2A8seFqgFJrJjEPY1Cn3pJ8/9W1e5VWsFDTEmFrBcoDhZJEQkXuhICMyKpjhahqN21hRYATKfUOlDmkygrR4o4C0VOLGJKrOITKB4jijzdXygBKixyC5TDQdnk/Pz8qRw6oOWGlsTKGOQW6OH6FBWsyePxdOXLTgxiyebILZCjz+GLgMIKnXNzc49YMlcRdHXcSwxFVgTInQhC9G33UhNoJLuqq6t345p9y3eUy8OTk5PjAHuI9uo4b07FBaOhsu0A4Unc+T1TU1Nj3KsSSE5yJ65jqF2DDd8QqWYmAZrIM2VlZTdnZmb6AbpdV9V6ec9znf5Q7HjYumdRE0JOp3MjitO4SFa+cZz8Umqe3TCbSLvdfkR/kWDdNQl5InuTcysOcpFT35ZrbBxx4p3JAHlZVVW1D/634VRt+FvLBgK/v5LV9WS+10xMTEwtRw7XvqOL+e2Q8V3AYIOIAXQ26/heWVnZCVfcyKHg2CBgTpmPmjYM8l24GyaUHyaIh7XwfR9ErE8qHoDfn2LTNAVC0HX6MFcBIP8Bi+6F6cdW/DICkANRfx99fEYFQ7Nph5i/uQiA214gno7K+guhaiKg9gC62+M8eR7XsBsYJ4ilam60Fb7r7uAj8wFyuwM1oIOWgfmDy6RXEEQzJMPe23DXrVS7rtyD3Df8z/FPgAEAzWU5Ku59ZAUAAAAASUVORK5CYII=)](/)
[![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpEQUM1QkUxRUI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpEQUM1QkUxRkI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdGQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjgwQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+hfPRaQAAB6lJREFUeNrsW2mME2UYbodtt+2222u35QheoCCYGBQligIJgkZJNPzgigoaTEj8AdFEMfADfyABkgWiiWcieK4S+QOiHAYUj2hMNKgYlEujpNttu9vttbvdw+chU1K6M535pt3ubHCSyezR+b73eb73+t7vrfXsufOW4bz6+vom9/b23ovnNNw34b5xYGAgODg46Mbt4mesVmsWd1qSpHhdXd2fuP/Afcput5/A88xwymcdBgLqenp6FuRyuWV4zu/v759QyWBjxoz5t76+/gun09mK5xFyakoCAPSaTCazNpvNPoYVbh6O1YKGRF0u13sNDQ27QMzfpiAAKj0lnU6/gBVfAZW2WWpwwVzy0IgP3G73FpjI6REhAGA9qVRqA1b9mVoBVyIC2tDi8Xg24+dUzQiAbS/s7Ox8G2o/3mKCC+Zw0efzPQEfcVjYrARX3dbV1bUtHo8fMgt42f+Mp0yUTVQbdWsAHVsikdiHkHaPxcQXQufXgUBgMRxme9U0AAxfH4vFvjM7eF6UkbJS5qoQwEQGA57Ac5JllFyUVZZ5ckUEgMVxsK2jlSYzI+QXJsiyjzNEAJyJAzb/KQa41jJKL8pODMQiTEAymXw5n8/P0IjD3bh7Rgog59aanxiIRTVvV/oj0tnHca/WMrVwODwB3raTGxzkBg/gnZVapFV62Wy2n5AO70HM/5wbJ0QnXyQSaVPDIuNZzY0V3ntHMwxiwHA0Gj2Np7ecIBDgaDAYXKCQJM1DhrgJ3nhulcPbl8j4NmHe46X/g60fwbz3aewjkqFQaAqebWU1AOqyQwt8Id6qEHMc97zu7u7FGGsn7HAiVuosVw7P35C1nccdgSCxop1dHeZswmfHMnxBo6ZTk+jN8dl/vF7vWofDsa+MLN9oEUBMxOb3+1eoEsBVw6Zmua49r8YmhAKDiEPcMwBsxMiqQ+ixzPFxZyqRpXARG/YOr1ObFJ0gUskXBbamcR1OKmMUvDxHRAu8/LmY3jFLMUpFqz9HxG65smYJdyKyECOxDiEAe/p1gjF2oonivZAsxVgl2daa4EQWCW6J55qFAFFZiJWYLxNQy2qOSUzGRsyXCUDIeliwAHEO4WSlWQBRFoZakXcKmCXmyXAKs0Ve9vl8q42WoIYpJU4hV3hKcNs8m9gl7p/xQ73eF5kB4j5mNrWmTJRNwAzqiV1CxjVTZCIkEq+Z1bZFZSN2CenmVAFVy4Plz8xKAGWjjAKFk6lCBMDR/MJjLLMSQNm43xAiQKTaA+9/wewhDjL+JVI1kkTSSOTcKbMTwPqESAot6dn6Fr1gHwVJju6IRuyiByPuUUBAg5DGkAgBmxlvdgIEK9gDkohdY/BJo4CAG0R8miRSsGABkgVQs4KXu098IgUXSSRsFAoKZiVAVDY2WUiiPTjYRi41KwGisrGsLtlsth8Fiwnz2fBkQvWfRtlE3iF2yW63/yCacXZ1dW02GwGyTFaRd4idJnCKHRaCxYRHoG5LTKT6SyiToP1fJHbmAYPYRR0UnZQtMnA6s0zg+GZBlt0Gdo7EPHgpE3Q6nZ8YyLhc8Xj8MJh/aKTAY+5FPAKHLE7RdwuYJZmNwzyCMkBCYyKROJBMJl9B/PXXCjjmCmDOVzH3fiPpObEWGqoKe4EBl8v1hlqsdLvd23mkxHM9pc9kMpmno9HoeTii7ewbHEZPPx1ztLS1tV3AnGuMjiNjvbQFuHw6zDo5By7dTPAQNBgMLrRarTkSls1mnwT7uwp9virx9QzbW/HuV/j5d/b+6jniKlllP8lkeONJDk+dq9GsQTnC4fB1heO0K47Hwe7WdDr9nAKgXwOBwHI+C45Htj1d6sd429TUNEcmUdc+PRaLHcvn87dXW4ugzdsaGxufL94NFv9zi1J7GVbhlvb2dnaJ3SVrxfc+n2+NTsZ7/H7/Mr3g5XdSIHyJSH1PZ+7fToyl2+ErqilgZ4NaLYB9goVGaHjR93Hv1ZrU4XDsFT20kH3PObzbWk0CgG1jacVIUnAQb9F+VexyLMzkpcLv0IJV7AHQIOCAUYHx7v5qgScmYHtTqSAyZLEJTK22Bie4iq3xsqpm4SAf9Hq9a2DnJ4uLK3SEULcdRvp3i3zHySqpficxEdsQc1NrlYXXvR+O7qASSezXB+h1SuUomgg9LL8BUoV4749EIolKh+EiqWmqVEZlDgHks2pxHw7xTqUQw9J5NcAXOK10AGIoZ6Zli6JY6Z1Q461KoZ4NiKLHarW+KDsxlDUPHZ5zPQZqUVDPJsTqb5n9malbpAh8C2XXDLl62+WZIDFRUlNVOiwencnNU3aQEkL+cDMSoLvZo2fQB7AJssNAuFuvorlDVVkkg2I87+jo2K2QAVphDrfyViK5VqtO34OkaxXCp+7drdDBCAdubm6eidX+2WwqT5komwh4YQLk+H4aE93h8Xg2gvHekQZOGSgLZTLyDTLJ4Lx9/KZWKBSainT4Iy3FqQBfnUZR42PKQFksBr9QKVXCPusD3OiA/RkQ5kP8qV/Jl1WywAp/6+dcmPM2zL1UrUahe4JqfnWWKXIul3uUbfP8njAFLW1OFr3gdFtZ72cNH+PtQT7/brW+NXqJAHh0y9V8/U/A1U7AfwIMAD7mS3pCbuWJAAAAAElFTkSuQmCC)](/)

---

# Page not found · GitHub Pages

404
===

**File not found**

The site configured at this address does not contain the requested file.

If this is your site, make sure that the filename case matches the URL as well as any file permissions.  
For root URLs (like `http://example.com/`) you must provide an `index.html` file.

[Read the full documentation](https://help.github.com/pages/)
 for more information about using **GitHub Pages**.

[GitHub Status](https://githubstatus.com)
 — [@githubstatus](https://twitter.com/githubstatus)

 [![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTZCRDY3REIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTZCRDY3RUIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdCQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjdDQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+SM9MCAAAA+5JREFUeNrEV11Ik1EY3s4+ddOp29Q5b0opCgKFsoKoi5Kg6CIhuwi6zLJLoYLopq4qsKKgi4i6CYIoU/q5iDAKs6syoS76IRWtyJ+p7cdt7sf1PGOD+e0c3dygAx/67ZzzPM95/877GYdHRg3ZjMXFxepQKNS6sLCwJxqNNuFpiMfjVs4ZjUa/pmmjeD6VlJS8NpvNT4QQ7mxwjSsJiEQim/1+/9lgMHgIr5ohuxG1WCw9Vqv1clFR0dCqBODElV6v90ogEDjGdYbVjXhpaendioqK07CIR7ZAqE49PT09BPL2PMgTByQGsYiZlQD4uMXtdr+JxWINhgINYhGT2MsKgMrm2dnZXgRXhaHAg5jEJodUAHxux4LudHJE9RdEdA+i3Juz7bGHe4mhE9FNrgwBCLirMFV9Okh5eflFh8PR5nK5nDabrR2BNJlKO0T35+Li4n4+/J+/JQCxhmu5h3uJoXNHPbmWZAHMshWB8l5/ipqammaAf0zPDDx1ONV3vurdidqwAQL+pEc8sLcAe1CCvQ3YHxIW8Pl85xSWNC1hADDIv0rIE/o4J0k3kww4xSlwIhcq3EFFOm7KN/hUGOQkt0CFa5WpNJlMvxBEz/IVQAxg/ZRZl9wiHA63yDYieM7DnLP5CiAGsC7I5sgtYKJGWe2A8seFqgFJrJjEPY1Cn3pJ8/9W1e5VWsFDTEmFrBcoDhZJEQkXuhICMyKpjhahqN21hRYATKfUOlDmkygrR4o4C0VOLGJKrOITKB4jijzdXygBKixyC5TDQdnk/Pz8qRw6oOWGlsTKGOQW6OH6FBWsyePxdOXLTgxiyebILZCjz+GLgMIKnXNzc49YMlcRdHXcSwxFVgTInQhC9G33UhNoJLuqq6t345p9y3eUy8OTk5PjAHuI9uo4b07FBaOhsu0A4Unc+T1TU1Nj3KsSSE5yJ65jqF2DDd8QqWYmAZrIM2VlZTdnZmb6AbpdV9V6ec9znf5Q7HjYumdRE0JOp3MjitO4SFa+cZz8Umqe3TCbSLvdfkR/kWDdNQl5InuTcysOcpFT35ZrbBxx4p3JAHlZVVW1D/634VRt+FvLBgK/v5LV9WS+10xMTEwtRw7XvqOL+e2Q8V3AYIOIAXQ26/heWVnZCVfcyKHg2CBgTpmPmjYM8l24GyaUHyaIh7XwfR9ErE8qHoDfn2LTNAVC0HX6MFcBIP8Bi+6F6cdW/DICkANRfx99fEYFQ7Nph5i/uQiA214gno7K+guhaiKg9gC62+M8eR7XsBsYJ4ilam60Fb7r7uAj8wFyuwM1oIOWgfmDy6RXEEQzJMPe23DXrVS7rtyD3Df8z/FPgAEAzWU5Ku59ZAUAAAAASUVORK5CYII=)](/)
[![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpEQUM1QkUxRUI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpEQUM1QkUxRkI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdGQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjgwQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+hfPRaQAAB6lJREFUeNrsW2mME2UYbodtt+2222u35QheoCCYGBQligIJgkZJNPzgigoaTEj8AdFEMfADfyABkgWiiWcieK4S+QOiHAYUj2hMNKgYlEujpNttu9vttbvdw+chU1K6M535pt3ubHCSyezR+b73eb73+t7vrfXsufOW4bz6+vom9/b23ovnNNw34b5xYGAgODg46Mbt4mesVmsWd1qSpHhdXd2fuP/Afcput5/A88xwymcdBgLqenp6FuRyuWV4zu/v759QyWBjxoz5t76+/gun09mK5xFyakoCAPSaTCazNpvNPoYVbh6O1YKGRF0u13sNDQ27QMzfpiAAKj0lnU6/gBVfAZW2WWpwwVzy0IgP3G73FpjI6REhAGA9qVRqA1b9mVoBVyIC2tDi8Xg24+dUzQiAbS/s7Ox8G2o/3mKCC+Zw0efzPQEfcVjYrARX3dbV1bUtHo8fMgt42f+Mp0yUTVQbdWsAHVsikdiHkHaPxcQXQufXgUBgMRxme9U0AAxfH4vFvjM7eF6UkbJS5qoQwEQGA57Ac5JllFyUVZZ5ckUEgMVxsK2jlSYzI+QXJsiyjzNEAJyJAzb/KQa41jJKL8pODMQiTEAymXw5n8/P0IjD3bh7Rgog59aanxiIRTVvV/oj0tnHca/WMrVwODwB3raTGxzkBg/gnZVapFV62Wy2n5AO70HM/5wbJ0QnXyQSaVPDIuNZzY0V3ntHMwxiwHA0Gj2Np7ecIBDgaDAYXKCQJM1DhrgJ3nhulcPbl8j4NmHe46X/g60fwbz3aewjkqFQaAqebWU1AOqyQwt8Id6qEHMc97zu7u7FGGsn7HAiVuosVw7P35C1nccdgSCxop1dHeZswmfHMnxBo6ZTk+jN8dl/vF7vWofDsa+MLN9oEUBMxOb3+1eoEsBVw6Zmua49r8YmhAKDiEPcMwBsxMiqQ+ixzPFxZyqRpXARG/YOr1ObFJ0gUskXBbamcR1OKmMUvDxHRAu8/LmY3jFLMUpFqz9HxG65smYJdyKyECOxDiEAe/p1gjF2oonivZAsxVgl2daa4EQWCW6J55qFAFFZiJWYLxNQy2qOSUzGRsyXCUDIeliwAHEO4WSlWQBRFoZakXcKmCXmyXAKs0Ve9vl8q42WoIYpJU4hV3hKcNs8m9gl7p/xQ73eF5kB4j5mNrWmTJRNwAzqiV1CxjVTZCIkEq+Z1bZFZSN2CenmVAFVy4Plz8xKAGWjjAKFk6lCBMDR/MJjLLMSQNm43xAiQKTaA+9/wewhDjL+JVI1kkTSSOTcKbMTwPqESAot6dn6Fr1gHwVJju6IRuyiByPuUUBAg5DGkAgBmxlvdgIEK9gDkohdY/BJo4CAG0R8miRSsGABkgVQs4KXu098IgUXSSRsFAoKZiVAVDY2WUiiPTjYRi41KwGisrGsLtlsth8Fiwnz2fBkQvWfRtlE3iF2yW63/yCacXZ1dW02GwGyTFaRd4idJnCKHRaCxYRHoG5LTKT6SyiToP1fJHbmAYPYRR0UnZQtMnA6s0zg+GZBlt0Gdo7EPHgpE3Q6nZ8YyLhc8Xj8MJh/aKTAY+5FPAKHLE7RdwuYJZmNwzyCMkBCYyKROJBMJl9B/PXXCjjmCmDOVzH3fiPpObEWGqoKe4EBl8v1hlqsdLvd23mkxHM9pc9kMpmno9HoeTii7ewbHEZPPx1ztLS1tV3AnGuMjiNjvbQFuHw6zDo5By7dTPAQNBgMLrRarTkSls1mnwT7uwp9virx9QzbW/HuV/j5d/b+6jniKlllP8lkeONJDk+dq9GsQTnC4fB1heO0K47Hwe7WdDr9nAKgXwOBwHI+C45Htj1d6sd429TUNEcmUdc+PRaLHcvn87dXW4ugzdsaGxufL94NFv9zi1J7GVbhlvb2dnaJ3SVrxfc+n2+NTsZ7/H7/Mr3g5XdSIHyJSH1PZ+7fToyl2+ErqilgZ4NaLYB9goVGaHjR93Hv1ZrU4XDsFT20kH3PObzbWk0CgG1jacVIUnAQb9F+VexyLMzkpcLv0IJV7AHQIOCAUYHx7v5qgScmYHtTqSAyZLEJTK22Bie4iq3xsqpm4SAf9Hq9a2DnJ4uLK3SEULcdRvp3i3zHySqpficxEdsQc1NrlYXXvR+O7qASSezXB+h1SuUomgg9LL8BUoV4749EIolKh+EiqWmqVEZlDgHks2pxHw7xTqUQw9J5NcAXOK10AGIoZ6Zli6JY6Z1Q461KoZ4NiKLHarW+KDsxlDUPHZ5zPQZqUVDPJsTqb5n9malbpAh8C2XXDLl62+WZIDFRUlNVOiwencnNU3aQEkL+cDMSoLvZo2fQB7AJssNAuFuvorlDVVkkg2I87+jo2K2QAVphDrfyViK5VqtO34OkaxXCp+7drdDBCAdubm6eidX+2WwqT5komwh4YQLk+H4aE93h8Xg2gvHekQZOGSgLZTLyDTLJ4Lx9/KZWKBSainT4Iy3FqQBfnUZR42PKQFksBr9QKVXCPusD3OiA/RkQ5kP8qV/Jl1WywAp/6+dcmPM2zL1UrUahe4JqfnWWKXIul3uUbfP8njAFLW1OFr3gdFtZ72cNH+PtQT7/brW+NXqJAHh0y9V8/U/A1U7AfwIMAD7mS3pCbuWJAAAAAElFTkSuQmCC)](/)

---

# Page not found · GitHub Pages

404
===

**File not found**

The site configured at this address does not contain the requested file.

If this is your site, make sure that the filename case matches the URL as well as any file permissions.  
For root URLs (like `http://example.com/`) you must provide an `index.html` file.

[Read the full documentation](https://help.github.com/pages/)
 for more information about using **GitHub Pages**.

[GitHub Status](https://githubstatus.com)
 — [@githubstatus](https://twitter.com/githubstatus)

 [![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTZCRDY3REIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTZCRDY3RUIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdCQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjdDQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+SM9MCAAAA+5JREFUeNrEV11Ik1EY3s4+ddOp29Q5b0opCgKFsoKoi5Kg6CIhuwi6zLJLoYLopq4qsKKgi4i6CYIoU/q5iDAKs6syoS76IRWtyJ+p7cdt7sf1PGOD+e0c3dygAx/67ZzzPM95/877GYdHRg3ZjMXFxepQKNS6sLCwJxqNNuFpiMfjVs4ZjUa/pmmjeD6VlJS8NpvNT4QQ7mxwjSsJiEQim/1+/9lgMHgIr5ohuxG1WCw9Vqv1clFR0dCqBODElV6v90ogEDjGdYbVjXhpaendioqK07CIR7ZAqE49PT09BPL2PMgTByQGsYiZlQD4uMXtdr+JxWINhgINYhGT2MsKgMrm2dnZXgRXhaHAg5jEJodUAHxux4LudHJE9RdEdA+i3Juz7bGHe4mhE9FNrgwBCLirMFV9Okh5eflFh8PR5nK5nDabrR2BNJlKO0T35+Li4n4+/J+/JQCxhmu5h3uJoXNHPbmWZAHMshWB8l5/ipqammaAf0zPDDx1ONV3vurdidqwAQL+pEc8sLcAe1CCvQ3YHxIW8Pl85xSWNC1hADDIv0rIE/o4J0k3kww4xSlwIhcq3EFFOm7KN/hUGOQkt0CFa5WpNJlMvxBEz/IVQAxg/ZRZl9wiHA63yDYieM7DnLP5CiAGsC7I5sgtYKJGWe2A8seFqgFJrJjEPY1Cn3pJ8/9W1e5VWsFDTEmFrBcoDhZJEQkXuhICMyKpjhahqN21hRYATKfUOlDmkygrR4o4C0VOLGJKrOITKB4jijzdXygBKixyC5TDQdnk/Pz8qRw6oOWGlsTKGOQW6OH6FBWsyePxdOXLTgxiyebILZCjz+GLgMIKnXNzc49YMlcRdHXcSwxFVgTInQhC9G33UhNoJLuqq6t345p9y3eUy8OTk5PjAHuI9uo4b07FBaOhsu0A4Unc+T1TU1Nj3KsSSE5yJ65jqF2DDd8QqWYmAZrIM2VlZTdnZmb6AbpdV9V6ec9znf5Q7HjYumdRE0JOp3MjitO4SFa+cZz8Umqe3TCbSLvdfkR/kWDdNQl5InuTcysOcpFT35ZrbBxx4p3JAHlZVVW1D/634VRt+FvLBgK/v5LV9WS+10xMTEwtRw7XvqOL+e2Q8V3AYIOIAXQ26/heWVnZCVfcyKHg2CBgTpmPmjYM8l24GyaUHyaIh7XwfR9ErE8qHoDfn2LTNAVC0HX6MFcBIP8Bi+6F6cdW/DICkANRfx99fEYFQ7Nph5i/uQiA214gno7K+guhaiKg9gC62+M8eR7XsBsYJ4ilam60Fb7r7uAj8wFyuwM1oIOWgfmDy6RXEEQzJMPe23DXrVS7rtyD3Df8z/FPgAEAzWU5Ku59ZAUAAAAASUVORK5CYII=)](/)
[![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpEQUM1QkUxRUI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpEQUM1QkUxRkI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdGQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjgwQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+hfPRaQAAB6lJREFUeNrsW2mME2UYbodtt+2222u35QheoCCYGBQligIJgkZJNPzgigoaTEj8AdFEMfADfyABkgWiiWcieK4S+QOiHAYUj2hMNKgYlEujpNttu9vttbvdw+chU1K6M535pt3ubHCSyezR+b73eb73+t7vrfXsufOW4bz6+vom9/b23ovnNNw34b5xYGAgODg46Mbt4mesVmsWd1qSpHhdXd2fuP/Afcput5/A88xwymcdBgLqenp6FuRyuWV4zu/v759QyWBjxoz5t76+/gun09mK5xFyakoCAPSaTCazNpvNPoYVbh6O1YKGRF0u13sNDQ27QMzfpiAAKj0lnU6/gBVfAZW2WWpwwVzy0IgP3G73FpjI6REhAGA9qVRqA1b9mVoBVyIC2tDi8Xg24+dUzQiAbS/s7Ox8G2o/3mKCC+Zw0efzPQEfcVjYrARX3dbV1bUtHo8fMgt42f+Mp0yUTVQbdWsAHVsikdiHkHaPxcQXQufXgUBgMRxme9U0AAxfH4vFvjM7eF6UkbJS5qoQwEQGA57Ac5JllFyUVZZ5ckUEgMVxsK2jlSYzI+QXJsiyjzNEAJyJAzb/KQa41jJKL8pODMQiTEAymXw5n8/P0IjD3bh7Rgog59aanxiIRTVvV/oj0tnHca/WMrVwODwB3raTGxzkBg/gnZVapFV62Wy2n5AO70HM/5wbJ0QnXyQSaVPDIuNZzY0V3ntHMwxiwHA0Gj2Np7ecIBDgaDAYXKCQJM1DhrgJ3nhulcPbl8j4NmHe46X/g60fwbz3aewjkqFQaAqebWU1AOqyQwt8Id6qEHMc97zu7u7FGGsn7HAiVuosVw7P35C1nccdgSCxop1dHeZswmfHMnxBo6ZTk+jN8dl/vF7vWofDsa+MLN9oEUBMxOb3+1eoEsBVw6Zmua49r8YmhAKDiEPcMwBsxMiqQ+ixzPFxZyqRpXARG/YOr1ObFJ0gUskXBbamcR1OKmMUvDxHRAu8/LmY3jFLMUpFqz9HxG65smYJdyKyECOxDiEAe/p1gjF2oonivZAsxVgl2daa4EQWCW6J55qFAFFZiJWYLxNQy2qOSUzGRsyXCUDIeliwAHEO4WSlWQBRFoZakXcKmCXmyXAKs0Ve9vl8q42WoIYpJU4hV3hKcNs8m9gl7p/xQ73eF5kB4j5mNrWmTJRNwAzqiV1CxjVTZCIkEq+Z1bZFZSN2CenmVAFVy4Plz8xKAGWjjAKFk6lCBMDR/MJjLLMSQNm43xAiQKTaA+9/wewhDjL+JVI1kkTSSOTcKbMTwPqESAot6dn6Fr1gHwVJju6IRuyiByPuUUBAg5DGkAgBmxlvdgIEK9gDkohdY/BJo4CAG0R8miRSsGABkgVQs4KXu098IgUXSSRsFAoKZiVAVDY2WUiiPTjYRi41KwGisrGsLtlsth8Fiwnz2fBkQvWfRtlE3iF2yW63/yCacXZ1dW02GwGyTFaRd4idJnCKHRaCxYRHoG5LTKT6SyiToP1fJHbmAYPYRR0UnZQtMnA6s0zg+GZBlt0Gdo7EPHgpE3Q6nZ8YyLhc8Xj8MJh/aKTAY+5FPAKHLE7RdwuYJZmNwzyCMkBCYyKROJBMJl9B/PXXCjjmCmDOVzH3fiPpObEWGqoKe4EBl8v1hlqsdLvd23mkxHM9pc9kMpmno9HoeTii7ewbHEZPPx1ztLS1tV3AnGuMjiNjvbQFuHw6zDo5By7dTPAQNBgMLrRarTkSls1mnwT7uwp9virx9QzbW/HuV/j5d/b+6jniKlllP8lkeONJDk+dq9GsQTnC4fB1heO0K47Hwe7WdDr9nAKgXwOBwHI+C45Htj1d6sd429TUNEcmUdc+PRaLHcvn87dXW4ugzdsaGxufL94NFv9zi1J7GVbhlvb2dnaJ3SVrxfc+n2+NTsZ7/H7/Mr3g5XdSIHyJSH1PZ+7fToyl2+ErqilgZ4NaLYB9goVGaHjR93Hv1ZrU4XDsFT20kH3PObzbWk0CgG1jacVIUnAQb9F+VexyLMzkpcLv0IJV7AHQIOCAUYHx7v5qgScmYHtTqSAyZLEJTK22Bie4iq3xsqpm4SAf9Hq9a2DnJ4uLK3SEULcdRvp3i3zHySqpficxEdsQc1NrlYXXvR+O7qASSezXB+h1SuUomgg9LL8BUoV4749EIolKh+EiqWmqVEZlDgHks2pxHw7xTqUQw9J5NcAXOK10AGIoZ6Zli6JY6Z1Q461KoZ4NiKLHarW+KDsxlDUPHZ5zPQZqUVDPJsTqb5n9malbpAh8C2XXDLl62+WZIDFRUlNVOiwencnNU3aQEkL+cDMSoLvZo2fQB7AJssNAuFuvorlDVVkkg2I87+jo2K2QAVphDrfyViK5VqtO34OkaxXCp+7drdDBCAdubm6eidX+2WwqT5komwh4YQLk+H4aE93h8Xg2gvHekQZOGSgLZTLyDTLJ4Lx9/KZWKBSainT4Iy3FqQBfnUZR42PKQFksBr9QKVXCPusD3OiA/RkQ5kP8qV/Jl1WywAp/6+dcmPM2zL1UrUahe4JqfnWWKXIul3uUbfP8njAFLW1OFr3gdFtZ72cNH+PtQT7/brW+NXqJAHh0y9V8/U/A1U7AfwIMAD7mS3pCbuWJAAAAAElFTkSuQmCC)](/)

---

# Page not found · GitHub Pages

404
===

**File not found**

The site configured at this address does not contain the requested file.

If this is your site, make sure that the filename case matches the URL as well as any file permissions.  
For root URLs (like `http://example.com/`) you must provide an `index.html` file.

[Read the full documentation](https://help.github.com/pages/)
 for more information about using **GitHub Pages**.

[GitHub Status](https://githubstatus.com)
 — [@githubstatus](https://twitter.com/githubstatus)

 [![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTZCRDY3REIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTZCRDY3RUIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdCQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjdDQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+SM9MCAAAA+5JREFUeNrEV11Ik1EY3s4+ddOp29Q5b0opCgKFsoKoi5Kg6CIhuwi6zLJLoYLopq4qsKKgi4i6CYIoU/q5iDAKs6syoS76IRWtyJ+p7cdt7sf1PGOD+e0c3dygAx/67ZzzPM95/877GYdHRg3ZjMXFxepQKNS6sLCwJxqNNuFpiMfjVs4ZjUa/pmmjeD6VlJS8NpvNT4QQ7mxwjSsJiEQim/1+/9lgMHgIr5ohuxG1WCw9Vqv1clFR0dCqBODElV6v90ogEDjGdYbVjXhpaendioqK07CIR7ZAqE49PT09BPL2PMgTByQGsYiZlQD4uMXtdr+JxWINhgINYhGT2MsKgMrm2dnZXgRXhaHAg5jEJodUAHxux4LudHJE9RdEdA+i3Juz7bGHe4mhE9FNrgwBCLirMFV9Okh5eflFh8PR5nK5nDabrR2BNJlKO0T35+Li4n4+/J+/JQCxhmu5h3uJoXNHPbmWZAHMshWB8l5/ipqammaAf0zPDDx1ONV3vurdidqwAQL+pEc8sLcAe1CCvQ3YHxIW8Pl85xSWNC1hADDIv0rIE/o4J0k3kww4xSlwIhcq3EFFOm7KN/hUGOQkt0CFa5WpNJlMvxBEz/IVQAxg/ZRZl9wiHA63yDYieM7DnLP5CiAGsC7I5sgtYKJGWe2A8seFqgFJrJjEPY1Cn3pJ8/9W1e5VWsFDTEmFrBcoDhZJEQkXuhICMyKpjhahqN21hRYATKfUOlDmkygrR4o4C0VOLGJKrOITKB4jijzdXygBKixyC5TDQdnk/Pz8qRw6oOWGlsTKGOQW6OH6FBWsyePxdOXLTgxiyebILZCjz+GLgMIKnXNzc49YMlcRdHXcSwxFVgTInQhC9G33UhNoJLuqq6t345p9y3eUy8OTk5PjAHuI9uo4b07FBaOhsu0A4Unc+T1TU1Nj3KsSSE5yJ65jqF2DDd8QqWYmAZrIM2VlZTdnZmb6AbpdV9V6ec9znf5Q7HjYumdRE0JOp3MjitO4SFa+cZz8Umqe3TCbSLvdfkR/kWDdNQl5InuTcysOcpFT35ZrbBxx4p3JAHlZVVW1D/634VRt+FvLBgK/v5LV9WS+10xMTEwtRw7XvqOL+e2Q8V3AYIOIAXQ26/heWVnZCVfcyKHg2CBgTpmPmjYM8l24GyaUHyaIh7XwfR9ErE8qHoDfn2LTNAVC0HX6MFcBIP8Bi+6F6cdW/DICkANRfx99fEYFQ7Nph5i/uQiA214gno7K+guhaiKg9gC62+M8eR7XsBsYJ4ilam60Fb7r7uAj8wFyuwM1oIOWgfmDy6RXEEQzJMPe23DXrVS7rtyD3Df8z/FPgAEAzWU5Ku59ZAUAAAAASUVORK5CYII=)](/)
[![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpEQUM1QkUxRUI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpEQUM1QkUxRkI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdGQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjgwQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+hfPRaQAAB6lJREFUeNrsW2mME2UYbodtt+2222u35QheoCCYGBQligIJgkZJNPzgigoaTEj8AdFEMfADfyABkgWiiWcieK4S+QOiHAYUj2hMNKgYlEujpNttu9vttbvdw+chU1K6M535pt3ubHCSyezR+b73eb73+t7vrfXsufOW4bz6+vom9/b23ovnNNw34b5xYGAgODg46Mbt4mesVmsWd1qSpHhdXd2fuP/Afcput5/A88xwymcdBgLqenp6FuRyuWV4zu/v759QyWBjxoz5t76+/gun09mK5xFyakoCAPSaTCazNpvNPoYVbh6O1YKGRF0u13sNDQ27QMzfpiAAKj0lnU6/gBVfAZW2WWpwwVzy0IgP3G73FpjI6REhAGA9qVRqA1b9mVoBVyIC2tDi8Xg24+dUzQiAbS/s7Ox8G2o/3mKCC+Zw0efzPQEfcVjYrARX3dbV1bUtHo8fMgt42f+Mp0yUTVQbdWsAHVsikdiHkHaPxcQXQufXgUBgMRxme9U0AAxfH4vFvjM7eF6UkbJS5qoQwEQGA57Ac5JllFyUVZZ5ckUEgMVxsK2jlSYzI+QXJsiyjzNEAJyJAzb/KQa41jJKL8pODMQiTEAymXw5n8/P0IjD3bh7Rgog59aanxiIRTVvV/oj0tnHca/WMrVwODwB3raTGxzkBg/gnZVapFV62Wy2n5AO70HM/5wbJ0QnXyQSaVPDIuNZzY0V3ntHMwxiwHA0Gj2Np7ecIBDgaDAYXKCQJM1DhrgJ3nhulcPbl8j4NmHe46X/g60fwbz3aewjkqFQaAqebWU1AOqyQwt8Id6qEHMc97zu7u7FGGsn7HAiVuosVw7P35C1nccdgSCxop1dHeZswmfHMnxBo6ZTk+jN8dl/vF7vWofDsa+MLN9oEUBMxOb3+1eoEsBVw6Zmua49r8YmhAKDiEPcMwBsxMiqQ+ixzPFxZyqRpXARG/YOr1ObFJ0gUskXBbamcR1OKmMUvDxHRAu8/LmY3jFLMUpFqz9HxG65smYJdyKyECOxDiEAe/p1gjF2oonivZAsxVgl2daa4EQWCW6J55qFAFFZiJWYLxNQy2qOSUzGRsyXCUDIeliwAHEO4WSlWQBRFoZakXcKmCXmyXAKs0Ve9vl8q42WoIYpJU4hV3hKcNs8m9gl7p/xQ73eF5kB4j5mNrWmTJRNwAzqiV1CxjVTZCIkEq+Z1bZFZSN2CenmVAFVy4Plz8xKAGWjjAKFk6lCBMDR/MJjLLMSQNm43xAiQKTaA+9/wewhDjL+JVI1kkTSSOTcKbMTwPqESAot6dn6Fr1gHwVJju6IRuyiByPuUUBAg5DGkAgBmxlvdgIEK9gDkohdY/BJo4CAG0R8miRSsGABkgVQs4KXu098IgUXSSRsFAoKZiVAVDY2WUiiPTjYRi41KwGisrGsLtlsth8Fiwnz2fBkQvWfRtlE3iF2yW63/yCacXZ1dW02GwGyTFaRd4idJnCKHRaCxYRHoG5LTKT6SyiToP1fJHbmAYPYRR0UnZQtMnA6s0zg+GZBlt0Gdo7EPHgpE3Q6nZ8YyLhc8Xj8MJh/aKTAY+5FPAKHLE7RdwuYJZmNwzyCMkBCYyKROJBMJl9B/PXXCjjmCmDOVzH3fiPpObEWGqoKe4EBl8v1hlqsdLvd23mkxHM9pc9kMpmno9HoeTii7ewbHEZPPx1ztLS1tV3AnGuMjiNjvbQFuHw6zDo5By7dTPAQNBgMLrRarTkSls1mnwT7uwp9virx9QzbW/HuV/j5d/b+6jniKlllP8lkeONJDk+dq9GsQTnC4fB1heO0K47Hwe7WdDr9nAKgXwOBwHI+C45Htj1d6sd429TUNEcmUdc+PRaLHcvn87dXW4ugzdsaGxufL94NFv9zi1J7GVbhlvb2dnaJ3SVrxfc+n2+NTsZ7/H7/Mr3g5XdSIHyJSH1PZ+7fToyl2+ErqilgZ4NaLYB9goVGaHjR93Hv1ZrU4XDsFT20kH3PObzbWk0CgG1jacVIUnAQb9F+VexyLMzkpcLv0IJV7AHQIOCAUYHx7v5qgScmYHtTqSAyZLEJTK22Bie4iq3xsqpm4SAf9Hq9a2DnJ4uLK3SEULcdRvp3i3zHySqpficxEdsQc1NrlYXXvR+O7qASSezXB+h1SuUomgg9LL8BUoV4749EIolKh+EiqWmqVEZlDgHks2pxHw7xTqUQw9J5NcAXOK10AGIoZ6Zli6JY6Z1Q461KoZ4NiKLHarW+KDsxlDUPHZ5zPQZqUVDPJsTqb5n9malbpAh8C2XXDLl62+WZIDFRUlNVOiwencnNU3aQEkL+cDMSoLvZo2fQB7AJssNAuFuvorlDVVkkg2I87+jo2K2QAVphDrfyViK5VqtO34OkaxXCp+7drdDBCAdubm6eidX+2WwqT5komwh4YQLk+H4aE93h8Xg2gvHekQZOGSgLZTLyDTLJ4Lx9/KZWKBSainT4Iy3FqQBfnUZR42PKQFksBr9QKVXCPusD3OiA/RkQ5kP8qV/Jl1WywAp/6+dcmPM2zL1UrUahe4JqfnWWKXIul3uUbfP8njAFLW1OFr3gdFtZ72cNH+PtQT7/brW+NXqJAHh0y9V8/U/A1U7AfwIMAD7mS3pCbuWJAAAAAElFTkSuQmCC)](/)

---

# PutBlockProgressEvents | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [PutBlockProgressEvents](helia.PutBlockProgressEvents.html)
    

Type alias PutBlockProgressEvents
=================================

PutBlockProgressEvents: [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"blocks:put:duplicate", [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
\> | [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"blocks:put:providers:notify", [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
\> | [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"blocks:put:blockstore:put", [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
\>

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# Page not found · GitHub Pages

404
===

**File not found**

The site configured at this address does not contain the requested file.

If this is your site, make sure that the filename case matches the URL as well as any file permissions.  
For root URLs (like `http://example.com/`) you must provide an `index.html` file.

[Read the full documentation](https://help.github.com/pages/)
 for more information about using **GitHub Pages**.

[GitHub Status](https://githubstatus.com)
 — [@githubstatus](https://twitter.com/githubstatus)

 [![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTZCRDY3REIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTZCRDY3RUIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdCQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjdDQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+SM9MCAAAA+5JREFUeNrEV11Ik1EY3s4+ddOp29Q5b0opCgKFsoKoi5Kg6CIhuwi6zLJLoYLopq4qsKKgi4i6CYIoU/q5iDAKs6syoS76IRWtyJ+p7cdt7sf1PGOD+e0c3dygAx/67ZzzPM95/877GYdHRg3ZjMXFxepQKNS6sLCwJxqNNuFpiMfjVs4ZjUa/pmmjeD6VlJS8NpvNT4QQ7mxwjSsJiEQim/1+/9lgMHgIr5ohuxG1WCw9Vqv1clFR0dCqBODElV6v90ogEDjGdYbVjXhpaendioqK07CIR7ZAqE49PT09BPL2PMgTByQGsYiZlQD4uMXtdr+JxWINhgINYhGT2MsKgMrm2dnZXgRXhaHAg5jEJodUAHxux4LudHJE9RdEdA+i3Juz7bGHe4mhE9FNrgwBCLirMFV9Okh5eflFh8PR5nK5nDabrR2BNJlKO0T35+Li4n4+/J+/JQCxhmu5h3uJoXNHPbmWZAHMshWB8l5/ipqammaAf0zPDDx1ONV3vurdidqwAQL+pEc8sLcAe1CCvQ3YHxIW8Pl85xSWNC1hADDIv0rIE/o4J0k3kww4xSlwIhcq3EFFOm7KN/hUGOQkt0CFa5WpNJlMvxBEz/IVQAxg/ZRZl9wiHA63yDYieM7DnLP5CiAGsC7I5sgtYKJGWe2A8seFqgFJrJjEPY1Cn3pJ8/9W1e5VWsFDTEmFrBcoDhZJEQkXuhICMyKpjhahqN21hRYATKfUOlDmkygrR4o4C0VOLGJKrOITKB4jijzdXygBKixyC5TDQdnk/Pz8qRw6oOWGlsTKGOQW6OH6FBWsyePxdOXLTgxiyebILZCjz+GLgMIKnXNzc49YMlcRdHXcSwxFVgTInQhC9G33UhNoJLuqq6t345p9y3eUy8OTk5PjAHuI9uo4b07FBaOhsu0A4Unc+T1TU1Nj3KsSSE5yJ65jqF2DDd8QqWYmAZrIM2VlZTdnZmb6AbpdV9V6ec9znf5Q7HjYumdRE0JOp3MjitO4SFa+cZz8Umqe3TCbSLvdfkR/kWDdNQl5InuTcysOcpFT35ZrbBxx4p3JAHlZVVW1D/634VRt+FvLBgK/v5LV9WS+10xMTEwtRw7XvqOL+e2Q8V3AYIOIAXQ26/heWVnZCVfcyKHg2CBgTpmPmjYM8l24GyaUHyaIh7XwfR9ErE8qHoDfn2LTNAVC0HX6MFcBIP8Bi+6F6cdW/DICkANRfx99fEYFQ7Nph5i/uQiA214gno7K+guhaiKg9gC62+M8eR7XsBsYJ4ilam60Fb7r7uAj8wFyuwM1oIOWgfmDy6RXEEQzJMPe23DXrVS7rtyD3Df8z/FPgAEAzWU5Ku59ZAUAAAAASUVORK5CYII=)](/)
[![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpEQUM1QkUxRUI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpEQUM1QkUxRkI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdGQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjgwQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+hfPRaQAAB6lJREFUeNrsW2mME2UYbodtt+2222u35QheoCCYGBQligIJgkZJNPzgigoaTEj8AdFEMfADfyABkgWiiWcieK4S+QOiHAYUj2hMNKgYlEujpNttu9vttbvdw+chU1K6M535pt3ubHCSyezR+b73eb73+t7vrfXsufOW4bz6+vom9/b23ovnNNw34b5xYGAgODg46Mbt4mesVmsWd1qSpHhdXd2fuP/Afcput5/A88xwymcdBgLqenp6FuRyuWV4zu/v759QyWBjxoz5t76+/gun09mK5xFyakoCAPSaTCazNpvNPoYVbh6O1YKGRF0u13sNDQ27QMzfpiAAKj0lnU6/gBVfAZW2WWpwwVzy0IgP3G73FpjI6REhAGA9qVRqA1b9mVoBVyIC2tDi8Xg24+dUzQiAbS/s7Ox8G2o/3mKCC+Zw0efzPQEfcVjYrARX3dbV1bUtHo8fMgt42f+Mp0yUTVQbdWsAHVsikdiHkHaPxcQXQufXgUBgMRxme9U0AAxfH4vFvjM7eF6UkbJS5qoQwEQGA57Ac5JllFyUVZZ5ckUEgMVxsK2jlSYzI+QXJsiyjzNEAJyJAzb/KQa41jJKL8pODMQiTEAymXw5n8/P0IjD3bh7Rgog59aanxiIRTVvV/oj0tnHca/WMrVwODwB3raTGxzkBg/gnZVapFV62Wy2n5AO70HM/5wbJ0QnXyQSaVPDIuNZzY0V3ntHMwxiwHA0Gj2Np7ecIBDgaDAYXKCQJM1DhrgJ3nhulcPbl8j4NmHe46X/g60fwbz3aewjkqFQaAqebWU1AOqyQwt8Id6qEHMc97zu7u7FGGsn7HAiVuosVw7P35C1nccdgSCxop1dHeZswmfHMnxBo6ZTk+jN8dl/vF7vWofDsa+MLN9oEUBMxOb3+1eoEsBVw6Zmua49r8YmhAKDiEPcMwBsxMiqQ+ixzPFxZyqRpXARG/YOr1ObFJ0gUskXBbamcR1OKmMUvDxHRAu8/LmY3jFLMUpFqz9HxG65smYJdyKyECOxDiEAe/p1gjF2oonivZAsxVgl2daa4EQWCW6J55qFAFFZiJWYLxNQy2qOSUzGRsyXCUDIeliwAHEO4WSlWQBRFoZakXcKmCXmyXAKs0Ve9vl8q42WoIYpJU4hV3hKcNs8m9gl7p/xQ73eF5kB4j5mNrWmTJRNwAzqiV1CxjVTZCIkEq+Z1bZFZSN2CenmVAFVy4Plz8xKAGWjjAKFk6lCBMDR/MJjLLMSQNm43xAiQKTaA+9/wewhDjL+JVI1kkTSSOTcKbMTwPqESAot6dn6Fr1gHwVJju6IRuyiByPuUUBAg5DGkAgBmxlvdgIEK9gDkohdY/BJo4CAG0R8miRSsGABkgVQs4KXu098IgUXSSRsFAoKZiVAVDY2WUiiPTjYRi41KwGisrGsLtlsth8Fiwnz2fBkQvWfRtlE3iF2yW63/yCacXZ1dW02GwGyTFaRd4idJnCKHRaCxYRHoG5LTKT6SyiToP1fJHbmAYPYRR0UnZQtMnA6s0zg+GZBlt0Gdo7EPHgpE3Q6nZ8YyLhc8Xj8MJh/aKTAY+5FPAKHLE7RdwuYJZmNwzyCMkBCYyKROJBMJl9B/PXXCjjmCmDOVzH3fiPpObEWGqoKe4EBl8v1hlqsdLvd23mkxHM9pc9kMpmno9HoeTii7ewbHEZPPx1ztLS1tV3AnGuMjiNjvbQFuHw6zDo5By7dTPAQNBgMLrRarTkSls1mnwT7uwp9virx9QzbW/HuV/j5d/b+6jniKlllP8lkeONJDk+dq9GsQTnC4fB1heO0K47Hwe7WdDr9nAKgXwOBwHI+C45Htj1d6sd429TUNEcmUdc+PRaLHcvn87dXW4ugzdsaGxufL94NFv9zi1J7GVbhlvb2dnaJ3SVrxfc+n2+NTsZ7/H7/Mr3g5XdSIHyJSH1PZ+7fToyl2+ErqilgZ4NaLYB9goVGaHjR93Hv1ZrU4XDsFT20kH3PObzbWk0CgG1jacVIUnAQb9F+VexyLMzkpcLv0IJV7AHQIOCAUYHx7v5qgScmYHtTqSAyZLEJTK22Bie4iq3xsqpm4SAf9Hq9a2DnJ4uLK3SEULcdRvp3i3zHySqpficxEdsQc1NrlYXXvR+O7qASSezXB+h1SuUomgg9LL8BUoV4749EIolKh+EiqWmqVEZlDgHks2pxHw7xTqUQw9J5NcAXOK10AGIoZ6Zli6JY6Z1Q461KoZ4NiKLHarW+KDsxlDUPHZ5zPQZqUVDPJsTqb5n9malbpAh8C2XXDLl62+WZIDFRUlNVOiwencnNU3aQEkL+cDMSoLvZo2fQB7AJssNAuFuvorlDVVkkg2I87+jo2K2QAVphDrfyViK5VqtO34OkaxXCp+7drdDBCAdubm6eidX+2WwqT5komwh4YQLk+H4aE93h8Xg2gvHekQZOGSgLZTLyDTLJ4Lx9/KZWKBSainT4Iy3FqQBfnUZR42PKQFksBr9QKVXCPusD3OiA/RkQ5kP8qV/Jl1WywAp/6+dcmPM2zL1UrUahe4JqfnWWKXIul3uUbfP8njAFLW1OFr3gdFtZ72cNH+PtQT7/brW+NXqJAHh0y9V8/U/A1U7AfwIMAD7mS3pCbuWJAAAAAElFTkSuQmCC)](/)

---

# Page not found · GitHub Pages

404
===

**File not found**

The site configured at this address does not contain the requested file.

If this is your site, make sure that the filename case matches the URL as well as any file permissions.  
For root URLs (like `http://example.com/`) you must provide an `index.html` file.

[Read the full documentation](https://help.github.com/pages/)
 for more information about using **GitHub Pages**.

[GitHub Status](https://githubstatus.com)
 — [@githubstatus](https://twitter.com/githubstatus)

 [![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTZCRDY3REIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTZCRDY3RUIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdCQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjdDQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+SM9MCAAAA+5JREFUeNrEV11Ik1EY3s4+ddOp29Q5b0opCgKFsoKoi5Kg6CIhuwi6zLJLoYLopq4qsKKgi4i6CYIoU/q5iDAKs6syoS76IRWtyJ+p7cdt7sf1PGOD+e0c3dygAx/67ZzzPM95/877GYdHRg3ZjMXFxepQKNS6sLCwJxqNNuFpiMfjVs4ZjUa/pmmjeD6VlJS8NpvNT4QQ7mxwjSsJiEQim/1+/9lgMHgIr5ohuxG1WCw9Vqv1clFR0dCqBODElV6v90ogEDjGdYbVjXhpaendioqK07CIR7ZAqE49PT09BPL2PMgTByQGsYiZlQD4uMXtdr+JxWINhgINYhGT2MsKgMrm2dnZXgRXhaHAg5jEJodUAHxux4LudHJE9RdEdA+i3Juz7bGHe4mhE9FNrgwBCLirMFV9Okh5eflFh8PR5nK5nDabrR2BNJlKO0T35+Li4n4+/J+/JQCxhmu5h3uJoXNHPbmWZAHMshWB8l5/ipqammaAf0zPDDx1ONV3vurdidqwAQL+pEc8sLcAe1CCvQ3YHxIW8Pl85xSWNC1hADDIv0rIE/o4J0k3kww4xSlwIhcq3EFFOm7KN/hUGOQkt0CFa5WpNJlMvxBEz/IVQAxg/ZRZl9wiHA63yDYieM7DnLP5CiAGsC7I5sgtYKJGWe2A8seFqgFJrJjEPY1Cn3pJ8/9W1e5VWsFDTEmFrBcoDhZJEQkXuhICMyKpjhahqN21hRYATKfUOlDmkygrR4o4C0VOLGJKrOITKB4jijzdXygBKixyC5TDQdnk/Pz8qRw6oOWGlsTKGOQW6OH6FBWsyePxdOXLTgxiyebILZCjz+GLgMIKnXNzc49YMlcRdHXcSwxFVgTInQhC9G33UhNoJLuqq6t345p9y3eUy8OTk5PjAHuI9uo4b07FBaOhsu0A4Unc+T1TU1Nj3KsSSE5yJ65jqF2DDd8QqWYmAZrIM2VlZTdnZmb6AbpdV9V6ec9znf5Q7HjYumdRE0JOp3MjitO4SFa+cZz8Umqe3TCbSLvdfkR/kWDdNQl5InuTcysOcpFT35ZrbBxx4p3JAHlZVVW1D/634VRt+FvLBgK/v5LV9WS+10xMTEwtRw7XvqOL+e2Q8V3AYIOIAXQ26/heWVnZCVfcyKHg2CBgTpmPmjYM8l24GyaUHyaIh7XwfR9ErE8qHoDfn2LTNAVC0HX6MFcBIP8Bi+6F6cdW/DICkANRfx99fEYFQ7Nph5i/uQiA214gno7K+guhaiKg9gC62+M8eR7XsBsYJ4ilam60Fb7r7uAj8wFyuwM1oIOWgfmDy6RXEEQzJMPe23DXrVS7rtyD3Df8z/FPgAEAzWU5Ku59ZAUAAAAASUVORK5CYII=)](/)
[![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpEQUM1QkUxRUI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpEQUM1QkUxRkI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdGQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjgwQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+hfPRaQAAB6lJREFUeNrsW2mME2UYbodtt+2222u35QheoCCYGBQligIJgkZJNPzgigoaTEj8AdFEMfADfyABkgWiiWcieK4S+QOiHAYUj2hMNKgYlEujpNttu9vttbvdw+chU1K6M535pt3ubHCSyezR+b73eb73+t7vrfXsufOW4bz6+vom9/b23ovnNNw34b5xYGAgODg46Mbt4mesVmsWd1qSpHhdXd2fuP/Afcput5/A88xwymcdBgLqenp6FuRyuWV4zu/v759QyWBjxoz5t76+/gun09mK5xFyakoCAPSaTCazNpvNPoYVbh6O1YKGRF0u13sNDQ27QMzfpiAAKj0lnU6/gBVfAZW2WWpwwVzy0IgP3G73FpjI6REhAGA9qVRqA1b9mVoBVyIC2tDi8Xg24+dUzQiAbS/s7Ox8G2o/3mKCC+Zw0efzPQEfcVjYrARX3dbV1bUtHo8fMgt42f+Mp0yUTVQbdWsAHVsikdiHkHaPxcQXQufXgUBgMRxme9U0AAxfH4vFvjM7eF6UkbJS5qoQwEQGA57Ac5JllFyUVZZ5ckUEgMVxsK2jlSYzI+QXJsiyjzNEAJyJAzb/KQa41jJKL8pODMQiTEAymXw5n8/P0IjD3bh7Rgog59aanxiIRTVvV/oj0tnHca/WMrVwODwB3raTGxzkBg/gnZVapFV62Wy2n5AO70HM/5wbJ0QnXyQSaVPDIuNZzY0V3ntHMwxiwHA0Gj2Np7ecIBDgaDAYXKCQJM1DhrgJ3nhulcPbl8j4NmHe46X/g60fwbz3aewjkqFQaAqebWU1AOqyQwt8Id6qEHMc97zu7u7FGGsn7HAiVuosVw7P35C1nccdgSCxop1dHeZswmfHMnxBo6ZTk+jN8dl/vF7vWofDsa+MLN9oEUBMxOb3+1eoEsBVw6Zmua49r8YmhAKDiEPcMwBsxMiqQ+ixzPFxZyqRpXARG/YOr1ObFJ0gUskXBbamcR1OKmMUvDxHRAu8/LmY3jFLMUpFqz9HxG65smYJdyKyECOxDiEAe/p1gjF2oonivZAsxVgl2daa4EQWCW6J55qFAFFZiJWYLxNQy2qOSUzGRsyXCUDIeliwAHEO4WSlWQBRFoZakXcKmCXmyXAKs0Ve9vl8q42WoIYpJU4hV3hKcNs8m9gl7p/xQ73eF5kB4j5mNrWmTJRNwAzqiV1CxjVTZCIkEq+Z1bZFZSN2CenmVAFVy4Plz8xKAGWjjAKFk6lCBMDR/MJjLLMSQNm43xAiQKTaA+9/wewhDjL+JVI1kkTSSOTcKbMTwPqESAot6dn6Fr1gHwVJju6IRuyiByPuUUBAg5DGkAgBmxlvdgIEK9gDkohdY/BJo4CAG0R8miRSsGABkgVQs4KXu098IgUXSSRsFAoKZiVAVDY2WUiiPTjYRi41KwGisrGsLtlsth8Fiwnz2fBkQvWfRtlE3iF2yW63/yCacXZ1dW02GwGyTFaRd4idJnCKHRaCxYRHoG5LTKT6SyiToP1fJHbmAYPYRR0UnZQtMnA6s0zg+GZBlt0Gdo7EPHgpE3Q6nZ8YyLhc8Xj8MJh/aKTAY+5FPAKHLE7RdwuYJZmNwzyCMkBCYyKROJBMJl9B/PXXCjjmCmDOVzH3fiPpObEWGqoKe4EBl8v1hlqsdLvd23mkxHM9pc9kMpmno9HoeTii7ewbHEZPPx1ztLS1tV3AnGuMjiNjvbQFuHw6zDo5By7dTPAQNBgMLrRarTkSls1mnwT7uwp9virx9QzbW/HuV/j5d/b+6jniKlllP8lkeONJDk+dq9GsQTnC4fB1heO0K47Hwe7WdDr9nAKgXwOBwHI+C45Htj1d6sd429TUNEcmUdc+PRaLHcvn87dXW4ugzdsaGxufL94NFv9zi1J7GVbhlvb2dnaJ3SVrxfc+n2+NTsZ7/H7/Mr3g5XdSIHyJSH1PZ+7fToyl2+ErqilgZ4NaLYB9goVGaHjR93Hv1ZrU4XDsFT20kH3PObzbWk0CgG1jacVIUnAQb9F+VexyLMzkpcLv0IJV7AHQIOCAUYHx7v5qgScmYHtTqSAyZLEJTK22Bie4iq3xsqpm4SAf9Hq9a2DnJ4uLK3SEULcdRvp3i3zHySqpficxEdsQc1NrlYXXvR+O7qASSezXB+h1SuUomgg9LL8BUoV4749EIolKh+EiqWmqVEZlDgHks2pxHw7xTqUQw9J5NcAXOK10AGIoZ6Zli6JY6Z1Q461KoZ4NiKLHarW+KDsxlDUPHZ5zPQZqUVDPJsTqb5n9malbpAh8C2XXDLl62+WZIDFRUlNVOiwencnNU3aQEkL+cDMSoLvZo2fQB7AJssNAuFuvorlDVVkkg2I87+jo2K2QAVphDrfyViK5VqtO34OkaxXCp+7drdDBCAdubm6eidX+2WwqT5komwh4YQLk+H4aE93h8Xg2gvHekQZOGSgLZTLyDTLJ4Lx9/KZWKBSainT4Iy3FqQBfnUZR42PKQFksBr9QKVXCPusD3OiA/RkQ5kP8qV/Jl1WywAp/6+dcmPM2zL1UrUahe4JqfnWWKXIul3uUbfP8njAFLW1OFr3gdFtZ72cNH+PtQT7/brW+NXqJAHh0y9V8/U/A1U7AfwIMAD7mS3pCbuWJAAAAAElFTkSuQmCC)](/)

---

# @helia/dag-cbor | Helia

*   [Helia](../index.html)
    
*   [@helia/dag-cbor](_helia_dag_cbor.html)
    

Module @helia/dag-cbor
======================

`@helia/dag-cbor` makes working with DAG-JSON [Helia](https://github.com/ipfs/helia)
 simple & straightforward.

See the [DAGCBOR](../interfaces/_helia_dag_cbor.DAGCBOR.html)
 interface for all available operations.

#### Example

    import { createHelia } from 'helia'import { dagCbor } from '@helia/dag-cbor'import { CID } from 'multiformats/cid'const helia = await createHelia()const d = dagCbor(helia)const cid = await d.add({  hello: 'world'})const obj = await d.get(cid)console.info(obj)// { hello: 'world' }
    

[![Helia logo](https://raw.githubusercontent.com/ipfs/helia/main/assets/helia.png)](https://github.com/ipfs/helia "Helia")

[@helia/dag-cbor](#md:heliadag-cbor)

=====================================

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
 [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 [![codecov](https://img.shields.io/codecov/c/github/ipfs/helia.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia)
 [![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia/main.yml?branch=main&style=flat-square)](https://github.com/ipfs/helia/actions/workflows/main.yml?query=branch%3Amain)

> Add/get IPLD blocks containing dag-cbor with your Helia node

[About](#md:about)

===================

`@helia/dag-cbor` makes working with DAG-JSON Helia simple & straightforward.

See the DAGCBOR interface for all available operations.

[Example](#md:example)

-----------------------

    import { createHelia } from 'helia'import { dagCbor } from '@helia/dag-cbor'import { CID } from 'multiformats/cid'const helia = await createHelia()const d = dagCbor(helia)const cid = await d.add({  hello: 'world'})const obj = await d.get(cid)console.info(obj)// { hello: 'world' }
    

[Install](#md:install)

=======================

    $ npm i @helia/dag-cbor
    

[Browser `<script>` tag](#md:browser-ltscriptgt-tag)

-----------------------------------------------------

Loading this module through a script tag will make its exports available as `HeliaDagCbor` in the global namespace.

    <script src="https://unpkg.com/@helia/dag-cbor/dist/index.min.js"></script>
    

[API Docs](#md:api-docs)

=========================

*   [https://ipfs.github.io/helia/modules/\_helia\_dag\_cbor.html](https://ipfs.github.io/helia/modules/_helia_dag_cbor.html)
    

[License](#md:license)

=======================

Licensed under either of

*   Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/helia/blob/main/packages/dag-cbor/LICENSE-APACHE)
     / [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
    )
*   MIT ([LICENSE-MIT](https://github.com/ipfs/helia/blob/main/packages/dag-cbor/LICENSE-MIT)
     / [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)
    )

[Contribute](#md:contribute)

=============================

Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia/issues)
.

Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md)
 for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md)
.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

### Index

### Interfaces

[AddOptions](../interfaces/_helia_dag_cbor.AddOptions.html)
 [DAGCBOR](../interfaces/_helia_dag_cbor.DAGCBOR.html)
 [DAGCBORComponents](../interfaces/_helia_dag_cbor.DAGCBORComponents.html)
 [GetOptions](../interfaces/_helia_dag_cbor.GetOptions.html)

### Functions

[dagCbor](../functions/_helia_dag_cbor.dagCbor-1.html)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[@helia/dag-cbor](#md:heliadag-cbor)
[About](#md:about)

*   [Example](#md:example)
    

[Install](#md:install)

*   [Browser <script> tag](#md:browser-ltscriptgt-tag)
    

[API Docs](#md:api-docs)
[License](#md:license)
[Contribute](#md:contribute)

---

# Page not found · GitHub Pages

404
===

**File not found**

The site configured at this address does not contain the requested file.

If this is your site, make sure that the filename case matches the URL as well as any file permissions.  
For root URLs (like `http://example.com/`) you must provide an `index.html` file.

[Read the full documentation](https://help.github.com/pages/)
 for more information about using **GitHub Pages**.

[GitHub Status](https://githubstatus.com)
 — [@githubstatus](https://twitter.com/githubstatus)

 [![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTZCRDY3REIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTZCRDY3RUIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdCQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjdDQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+SM9MCAAAA+5JREFUeNrEV11Ik1EY3s4+ddOp29Q5b0opCgKFsoKoi5Kg6CIhuwi6zLJLoYLopq4qsKKgi4i6CYIoU/q5iDAKs6syoS76IRWtyJ+p7cdt7sf1PGOD+e0c3dygAx/67ZzzPM95/877GYdHRg3ZjMXFxepQKNS6sLCwJxqNNuFpiMfjVs4ZjUa/pmmjeD6VlJS8NpvNT4QQ7mxwjSsJiEQim/1+/9lgMHgIr5ohuxG1WCw9Vqv1clFR0dCqBODElV6v90ogEDjGdYbVjXhpaendioqK07CIR7ZAqE49PT09BPL2PMgTByQGsYiZlQD4uMXtdr+JxWINhgINYhGT2MsKgMrm2dnZXgRXhaHAg5jEJodUAHxux4LudHJE9RdEdA+i3Juz7bGHe4mhE9FNrgwBCLirMFV9Okh5eflFh8PR5nK5nDabrR2BNJlKO0T35+Li4n4+/J+/JQCxhmu5h3uJoXNHPbmWZAHMshWB8l5/ipqammaAf0zPDDx1ONV3vurdidqwAQL+pEc8sLcAe1CCvQ3YHxIW8Pl85xSWNC1hADDIv0rIE/o4J0k3kww4xSlwIhcq3EFFOm7KN/hUGOQkt0CFa5WpNJlMvxBEz/IVQAxg/ZRZl9wiHA63yDYieM7DnLP5CiAGsC7I5sgtYKJGWe2A8seFqgFJrJjEPY1Cn3pJ8/9W1e5VWsFDTEmFrBcoDhZJEQkXuhICMyKpjhahqN21hRYATKfUOlDmkygrR4o4C0VOLGJKrOITKB4jijzdXygBKixyC5TDQdnk/Pz8qRw6oOWGlsTKGOQW6OH6FBWsyePxdOXLTgxiyebILZCjz+GLgMIKnXNzc49YMlcRdHXcSwxFVgTInQhC9G33UhNoJLuqq6t345p9y3eUy8OTk5PjAHuI9uo4b07FBaOhsu0A4Unc+T1TU1Nj3KsSSE5yJ65jqF2DDd8QqWYmAZrIM2VlZTdnZmb6AbpdV9V6ec9znf5Q7HjYumdRE0JOp3MjitO4SFa+cZz8Umqe3TCbSLvdfkR/kWDdNQl5InuTcysOcpFT35ZrbBxx4p3JAHlZVVW1D/634VRt+FvLBgK/v5LV9WS+10xMTEwtRw7XvqOL+e2Q8V3AYIOIAXQ26/heWVnZCVfcyKHg2CBgTpmPmjYM8l24GyaUHyaIh7XwfR9ErE8qHoDfn2LTNAVC0HX6MFcBIP8Bi+6F6cdW/DICkANRfx99fEYFQ7Nph5i/uQiA214gno7K+guhaiKg9gC62+M8eR7XsBsYJ4ilam60Fb7r7uAj8wFyuwM1oIOWgfmDy6RXEEQzJMPe23DXrVS7rtyD3Df8z/FPgAEAzWU5Ku59ZAUAAAAASUVORK5CYII=)](/)
[![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpEQUM1QkUxRUI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpEQUM1QkUxRkI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdGQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjgwQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+hfPRaQAAB6lJREFUeNrsW2mME2UYbodtt+2222u35QheoCCYGBQligIJgkZJNPzgigoaTEj8AdFEMfADfyABkgWiiWcieK4S+QOiHAYUj2hMNKgYlEujpNttu9vttbvdw+chU1K6M535pt3ubHCSyezR+b73eb73+t7vrfXsufOW4bz6+vom9/b23ovnNNw34b5xYGAgODg46Mbt4mesVmsWd1qSpHhdXd2fuP/Afcput5/A88xwymcdBgLqenp6FuRyuWV4zu/v759QyWBjxoz5t76+/gun09mK5xFyakoCAPSaTCazNpvNPoYVbh6O1YKGRF0u13sNDQ27QMzfpiAAKj0lnU6/gBVfAZW2WWpwwVzy0IgP3G73FpjI6REhAGA9qVRqA1b9mVoBVyIC2tDi8Xg24+dUzQiAbS/s7Ox8G2o/3mKCC+Zw0efzPQEfcVjYrARX3dbV1bUtHo8fMgt42f+Mp0yUTVQbdWsAHVsikdiHkHaPxcQXQufXgUBgMRxme9U0AAxfH4vFvjM7eF6UkbJS5qoQwEQGA57Ac5JllFyUVZZ5ckUEgMVxsK2jlSYzI+QXJsiyjzNEAJyJAzb/KQa41jJKL8pODMQiTEAymXw5n8/P0IjD3bh7Rgog59aanxiIRTVvV/oj0tnHca/WMrVwODwB3raTGxzkBg/gnZVapFV62Wy2n5AO70HM/5wbJ0QnXyQSaVPDIuNZzY0V3ntHMwxiwHA0Gj2Np7ecIBDgaDAYXKCQJM1DhrgJ3nhulcPbl8j4NmHe46X/g60fwbz3aewjkqFQaAqebWU1AOqyQwt8Id6qEHMc97zu7u7FGGsn7HAiVuosVw7P35C1nccdgSCxop1dHeZswmfHMnxBo6ZTk+jN8dl/vF7vWofDsa+MLN9oEUBMxOb3+1eoEsBVw6Zmua49r8YmhAKDiEPcMwBsxMiqQ+ixzPFxZyqRpXARG/YOr1ObFJ0gUskXBbamcR1OKmMUvDxHRAu8/LmY3jFLMUpFqz9HxG65smYJdyKyECOxDiEAe/p1gjF2oonivZAsxVgl2daa4EQWCW6J55qFAFFZiJWYLxNQy2qOSUzGRsyXCUDIeliwAHEO4WSlWQBRFoZakXcKmCXmyXAKs0Ve9vl8q42WoIYpJU4hV3hKcNs8m9gl7p/xQ73eF5kB4j5mNrWmTJRNwAzqiV1CxjVTZCIkEq+Z1bZFZSN2CenmVAFVy4Plz8xKAGWjjAKFk6lCBMDR/MJjLLMSQNm43xAiQKTaA+9/wewhDjL+JVI1kkTSSOTcKbMTwPqESAot6dn6Fr1gHwVJju6IRuyiByPuUUBAg5DGkAgBmxlvdgIEK9gDkohdY/BJo4CAG0R8miRSsGABkgVQs4KXu098IgUXSSRsFAoKZiVAVDY2WUiiPTjYRi41KwGisrGsLtlsth8Fiwnz2fBkQvWfRtlE3iF2yW63/yCacXZ1dW02GwGyTFaRd4idJnCKHRaCxYRHoG5LTKT6SyiToP1fJHbmAYPYRR0UnZQtMnA6s0zg+GZBlt0Gdo7EPHgpE3Q6nZ8YyLhc8Xj8MJh/aKTAY+5FPAKHLE7RdwuYJZmNwzyCMkBCYyKROJBMJl9B/PXXCjjmCmDOVzH3fiPpObEWGqoKe4EBl8v1hlqsdLvd23mkxHM9pc9kMpmno9HoeTii7ewbHEZPPx1ztLS1tV3AnGuMjiNjvbQFuHw6zDo5By7dTPAQNBgMLrRarTkSls1mnwT7uwp9virx9QzbW/HuV/j5d/b+6jniKlllP8lkeONJDk+dq9GsQTnC4fB1heO0K47Hwe7WdDr9nAKgXwOBwHI+C45Htj1d6sd429TUNEcmUdc+PRaLHcvn87dXW4ugzdsaGxufL94NFv9zi1J7GVbhlvb2dnaJ3SVrxfc+n2+NTsZ7/H7/Mr3g5XdSIHyJSH1PZ+7fToyl2+ErqilgZ4NaLYB9goVGaHjR93Hv1ZrU4XDsFT20kH3PObzbWk0CgG1jacVIUnAQb9F+VexyLMzkpcLv0IJV7AHQIOCAUYHx7v5qgScmYHtTqSAyZLEJTK22Bie4iq3xsqpm4SAf9Hq9a2DnJ4uLK3SEULcdRvp3i3zHySqpficxEdsQc1NrlYXXvR+O7qASSezXB+h1SuUomgg9LL8BUoV4749EIolKh+EiqWmqVEZlDgHks2pxHw7xTqUQw9J5NcAXOK10AGIoZ6Zli6JY6Z1Q461KoZ4NiKLHarW+KDsxlDUPHZ5zPQZqUVDPJsTqb5n9malbpAh8C2XXDLl62+WZIDFRUlNVOiwencnNU3aQEkL+cDMSoLvZo2fQB7AJssNAuFuvorlDVVkkg2I87+jo2K2QAVphDrfyViK5VqtO34OkaxXCp+7drdDBCAdubm6eidX+2WwqT5komwh4YQLk+H4aE93h8Xg2gvHekQZOGSgLZTLyDTLJ4Lx9/KZWKBSainT4Iy3FqQBfnUZR42PKQFksBr9QKVXCPusD3OiA/RkQ5kP8qV/Jl1WywAp/6+dcmPM2zL1UrUahe4JqfnWWKXIul3uUbfP8njAFLW1OFr3gdFtZ72cNH+PtQT7/brW+NXqJAHh0y9V8/U/A1U7AfwIMAD7mS3pCbuWJAAAAAElFTkSuQmCC)](/)

---

# Site not found · GitHub Pages

404
===

**There isn't a GitHub Pages site here.**

If you're trying to publish one, [read the full documentation](https://help.github.com/pages/)
 to learn how to set up **GitHub Pages** for your repository, organization, or user account.

[GitHub Status](https://githubstatus.com)
 — [@githubstatus](https://twitter.com/githubstatus)

 [![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTZCRDY3REIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTZCRDY3RUIzRjAxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdCQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjdDQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+SM9MCAAAA+5JREFUeNrEV11Ik1EY3s4+ddOp29Q5b0opCgKFsoKoi5Kg6CIhuwi6zLJLoYLopq4qsKKgi4i6CYIoU/q5iDAKs6syoS76IRWtyJ+p7cdt7sf1PGOD+e0c3dygAx/67ZzzPM95/877GYdHRg3ZjMXFxepQKNS6sLCwJxqNNuFpiMfjVs4ZjUa/pmmjeD6VlJS8NpvNT4QQ7mxwjSsJiEQim/1+/9lgMHgIr5ohuxG1WCw9Vqv1clFR0dCqBODElV6v90ogEDjGdYbVjXhpaendioqK07CIR7ZAqE49PT09BPL2PMgTByQGsYiZlQD4uMXtdr+JxWINhgINYhGT2MsKgMrm2dnZXgRXhaHAg5jEJodUAHxux4LudHJE9RdEdA+i3Juz7bGHe4mhE9FNrgwBCLirMFV9Okh5eflFh8PR5nK5nDabrR2BNJlKO0T35+Li4n4+/J+/JQCxhmu5h3uJoXNHPbmWZAHMshWB8l5/ipqammaAf0zPDDx1ONV3vurdidqwAQL+pEc8sLcAe1CCvQ3YHxIW8Pl85xSWNC1hADDIv0rIE/o4J0k3kww4xSlwIhcq3EFFOm7KN/hUGOQkt0CFa5WpNJlMvxBEz/IVQAxg/ZRZl9wiHA63yDYieM7DnLP5CiAGsC7I5sgtYKJGWe2A8seFqgFJrJjEPY1Cn3pJ8/9W1e5VWsFDTEmFrBcoDhZJEQkXuhICMyKpjhahqN21hRYATKfUOlDmkygrR4o4C0VOLGJKrOITKB4jijzdXygBKixyC5TDQdnk/Pz8qRw6oOWGlsTKGOQW6OH6FBWsyePxdOXLTgxiyebILZCjz+GLgMIKnXNzc49YMlcRdHXcSwxFVgTInQhC9G33UhNoJLuqq6t345p9y3eUy8OTk5PjAHuI9uo4b07FBaOhsu0A4Unc+T1TU1Nj3KsSSE5yJ65jqF2DDd8QqWYmAZrIM2VlZTdnZmb6AbpdV9V6ec9znf5Q7HjYumdRE0JOp3MjitO4SFa+cZz8Umqe3TCbSLvdfkR/kWDdNQl5InuTcysOcpFT35ZrbBxx4p3JAHlZVVW1D/634VRt+FvLBgK/v5LV9WS+10xMTEwtRw7XvqOL+e2Q8V3AYIOIAXQ26/heWVnZCVfcyKHg2CBgTpmPmjYM8l24GyaUHyaIh7XwfR9ErE8qHoDfn2LTNAVC0HX6MFcBIP8Bi+6F6cdW/DICkANRfx99fEYFQ7Nph5i/uQiA214gno7K+guhaiKg9gC62+M8eR7XsBsYJ4ilam60Fb7r7uAj8wFyuwM1oIOWgfmDy6RXEEQzJMPe23DXrVS7rtyD3Df8z/FPgAEAzWU5Ku59ZAUAAAAASUVORK5CYII=)](/)
[![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpEQUM1QkUxRUI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpEQUM1QkUxRkI0MUMxMUUyQUQzREIxQzRENUFFNUM5NiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkUxNkJENjdGQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkUxNkJENjgwQjNGMDExRTJBRDNEQjFDNEQ1QUU1Qzk2Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+hfPRaQAAB6lJREFUeNrsW2mME2UYbodtt+2222u35QheoCCYGBQligIJgkZJNPzgigoaTEj8AdFEMfADfyABkgWiiWcieK4S+QOiHAYUj2hMNKgYlEujpNttu9vttbvdw+chU1K6M535pt3ubHCSyezR+b73eb73+t7vrfXsufOW4bz6+vom9/b23ovnNNw34b5xYGAgODg46Mbt4mesVmsWd1qSpHhdXd2fuP/Afcput5/A88xwymcdBgLqenp6FuRyuWV4zu/v759QyWBjxoz5t76+/gun09mK5xFyakoCAPSaTCazNpvNPoYVbh6O1YKGRF0u13sNDQ27QMzfpiAAKj0lnU6/gBVfAZW2WWpwwVzy0IgP3G73FpjI6REhAGA9qVRqA1b9mVoBVyIC2tDi8Xg24+dUzQiAbS/s7Ox8G2o/3mKCC+Zw0efzPQEfcVjYrARX3dbV1bUtHo8fMgt42f+Mp0yUTVQbdWsAHVsikdiHkHaPxcQXQufXgUBgMRxme9U0AAxfH4vFvjM7eF6UkbJS5qoQwEQGA57Ac5JllFyUVZZ5ckUEgMVxsK2jlSYzI+QXJsiyjzNEAJyJAzb/KQa41jJKL8pODMQiTEAymXw5n8/P0IjD3bh7Rgog59aanxiIRTVvV/oj0tnHca/WMrVwODwB3raTGxzkBg/gnZVapFV62Wy2n5AO70HM/5wbJ0QnXyQSaVPDIuNZzY0V3ntHMwxiwHA0Gj2Np7ecIBDgaDAYXKCQJM1DhrgJ3nhulcPbl8j4NmHe46X/g60fwbz3aewjkqFQaAqebWU1AOqyQwt8Id6qEHMc97zu7u7FGGsn7HAiVuosVw7P35C1nccdgSCxop1dHeZswmfHMnxBo6ZTk+jN8dl/vF7vWofDsa+MLN9oEUBMxOb3+1eoEsBVw6Zmua49r8YmhAKDiEPcMwBsxMiqQ+ixzPFxZyqRpXARG/YOr1ObFJ0gUskXBbamcR1OKmMUvDxHRAu8/LmY3jFLMUpFqz9HxG65smYJdyKyECOxDiEAe/p1gjF2oonivZAsxVgl2daa4EQWCW6J55qFAFFZiJWYLxNQy2qOSUzGRsyXCUDIeliwAHEO4WSlWQBRFoZakXcKmCXmyXAKs0Ve9vl8q42WoIYpJU4hV3hKcNs8m9gl7p/xQ73eF5kB4j5mNrWmTJRNwAzqiV1CxjVTZCIkEq+Z1bZFZSN2CenmVAFVy4Plz8xKAGWjjAKFk6lCBMDR/MJjLLMSQNm43xAiQKTaA+9/wewhDjL+JVI1kkTSSOTcKbMTwPqESAot6dn6Fr1gHwVJju6IRuyiByPuUUBAg5DGkAgBmxlvdgIEK9gDkohdY/BJo4CAG0R8miRSsGABkgVQs4KXu098IgUXSSRsFAoKZiVAVDY2WUiiPTjYRi41KwGisrGsLtlsth8Fiwnz2fBkQvWfRtlE3iF2yW63/yCacXZ1dW02GwGyTFaRd4idJnCKHRaCxYRHoG5LTKT6SyiToP1fJHbmAYPYRR0UnZQtMnA6s0zg+GZBlt0Gdo7EPHgpE3Q6nZ8YyLhc8Xj8MJh/aKTAY+5FPAKHLE7RdwuYJZmNwzyCMkBCYyKROJBMJl9B/PXXCjjmCmDOVzH3fiPpObEWGqoKe4EBl8v1hlqsdLvd23mkxHM9pc9kMpmno9HoeTii7ewbHEZPPx1ztLS1tV3AnGuMjiNjvbQFuHw6zDo5By7dTPAQNBgMLrRarTkSls1mnwT7uwp9virx9QzbW/HuV/j5d/b+6jniKlllP8lkeONJDk+dq9GsQTnC4fB1heO0K47Hwe7WdDr9nAKgXwOBwHI+C45Htj1d6sd429TUNEcmUdc+PRaLHcvn87dXW4ugzdsaGxufL94NFv9zi1J7GVbhlvb2dnaJ3SVrxfc+n2+NTsZ7/H7/Mr3g5XdSIHyJSH1PZ+7fToyl2+ErqilgZ4NaLYB9goVGaHjR93Hv1ZrU4XDsFT20kH3PObzbWk0CgG1jacVIUnAQb9F+VexyLMzkpcLv0IJV7AHQIOCAUYHx7v5qgScmYHtTqSAyZLEJTK22Bie4iq3xsqpm4SAf9Hq9a2DnJ4uLK3SEULcdRvp3i3zHySqpficxEdsQc1NrlYXXvR+O7qASSezXB+h1SuUomgg9LL8BUoV4749EIolKh+EiqWmqVEZlDgHks2pxHw7xTqUQw9J5NcAXOK10AGIoZ6Zli6JY6Z1Q461KoZ4NiKLHarW+KDsxlDUPHZ5zPQZqUVDPJsTqb5n9malbpAh8C2XXDLl62+WZIDFRUlNVOiwencnNU3aQEkL+cDMSoLvZo2fQB7AJssNAuFuvorlDVVkkg2I87+jo2K2QAVphDrfyViK5VqtO34OkaxXCp+7drdDBCAdubm6eidX+2WwqT5komwh4YQLk+H4aE93h8Xg2gvHekQZOGSgLZTLyDTLJ4Lx9/KZWKBSainT4Iy3FqQBfnUZR42PKQFksBr9QKVXCPusD3OiA/RkQ5kP8qV/Jl1WywAp/6+dcmPM2zL1UrUahe4JqfnWWKXIul3uUbfP8njAFLW1OFr3gdFtZ72cNH+PtQT7/brW+NXqJAHh0y9V8/U/A1U7AfwIMAD7mS3pCbuWJAAAAAElFTkSuQmCC)](/)

---

# helia | Helia

*   [Helia](../index.html)
    
*   [helia](helia.html)
    

Module helia
============

Exports a `createHelia` function that returns an object that implements the [Helia](../interfaces/helia.Helia.html)
 API.

Pass it to other modules like [@helia/unixfs](https://www.npmjs.com/package/@helia/unixfs)
 to make files available on the distributed web.

#### Example

    import { createHelia } from 'helia'import { unixfs } from '@helia/unixfs'import { CID } from 'multiformats/cid'const helia = await createHelia()const fs = unixfs(helia)fs.cat(CID.parse('bafyFoo'))
    

[![Helia logo](https://raw.githubusercontent.com/ipfs/helia/main/assets/helia.png)](https://github.com/ipfs/helia "Helia")

[helia](#md:helia)

===================

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
 [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 [![codecov](https://img.shields.io/codecov/c/github/ipfs/helia.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia)
 [![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia/main.yml?branch=main&style=flat-square)](https://github.com/ipfs/helia/actions/workflows/main.yml?query=branch%3Amain)

> An implementation of IPFS in JavaScript

[About](#md:about)

===================

Exports a `createHelia` function that returns an object that implements the Helia API.

Pass it to other modules like @helia/unixfs to make files available on the distributed web.

[Example](#md:example)

-----------------------

    import { createHelia } from 'helia'import { unixfs } from '@helia/unixfs'import { CID } from 'multiformats/cid'const helia = await createHelia()const fs = unixfs(helia)fs.cat(CID.parse('bafyFoo'))
    

[Install](#md:install)

=======================

    $ npm i helia
    

[Browser `<script>` tag](#md:browser-ltscriptgt-tag)

-----------------------------------------------------

Loading this module through a script tag will make its exports available as `Helia` in the global namespace.

    <script src="https://unpkg.com/helia/dist/index.min.js"></script>
    

[API Docs](#md:api-docs)

=========================

*   [https://ipfs.github.io/helia/modules/helia.html](https://ipfs.github.io/helia/modules/helia.html)
    

[License](#md:license)

=======================

Licensed under either of

*   Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/helia/blob/main/packages/helia/LICENSE-APACHE)
     / [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
    )
*   MIT ([LICENSE-MIT](https://github.com/ipfs/helia/blob/main/packages/helia/LICENSE-MIT)
     / [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)
    )

[Contribute](#md:contribute)

=============================

Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia/issues)
.

Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md)
 for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md)
.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

### Index

### Classes

[InsufficientProvidersError](../classes/helia.InsufficientProvidersError.html)
 [NoRoutersAvailableError](../classes/helia.NoRoutersAvailableError.html)
 [UnknownCodecError](../classes/helia.UnknownCodecError.html)
 [UnknownHashAlgorithmError](../classes/helia.UnknownHashAlgorithmError.html)

### Interfaces

[AddOptions](../interfaces/helia.AddOptions.html)
 [BlockAnnounceOptions](../interfaces/helia.BlockAnnounceOptions.html)
 [BlockBroker](../interfaces/helia.BlockBroker.html)
 [BlockRetrievalOptions](../interfaces/helia.BlockRetrievalOptions.html)
 [Blocks](../interfaces/helia.Blocks.html)
 [CodecLoader](../interfaces/helia.CodecLoader.html)
 [CreateSessionOptions](../interfaces/helia.CreateSessionOptions.html)
 [DAGWalker](../interfaces/helia.DAGWalker.html)
 [DefaultLibp2pServices](../interfaces/helia.DefaultLibp2pServices.html)
 [GCOptions](../interfaces/helia.GCOptions.html)
 [GetOfflineOptions](../interfaces/helia.GetOfflineOptions.html)
 [HasherLoader](../interfaces/helia.HasherLoader.html)
 [Helia](../interfaces/helia.Helia.html)
 [HeliaInit](../interfaces/helia.HeliaInit.html)
 [HeliaLibp2p](../interfaces/helia.HeliaLibp2p.html)
 [IsPinnedOptions](../interfaces/helia.IsPinnedOptions.html)
 [Libp2pDefaultsOptions](../interfaces/helia.Libp2pDefaultsOptions.html)
 [LsOptions](../interfaces/helia.LsOptions.html)
 [Pair](../interfaces/helia.Pair.html)
 [Pin](../interfaces/helia.Pin.html)
 [Pins](../interfaces/helia.Pins.html)
 [Provider](../interfaces/helia.Provider.html)
 [RmOptions](../interfaces/helia.RmOptions.html)
 [Routing](../interfaces/helia.Routing.html)
 [RoutingOptions](../interfaces/helia.RoutingOptions.html)
 [SessionBlockstore](../interfaces/helia.SessionBlockstore.html)

### Type Aliases

[AddPinEvents](../types/helia.AddPinEvents.html)
 [Await](../types/helia.Await.html)
 [AwaitIterable](../types/helia.AwaitIterable.html)
 [DeleteBlockProgressEvents](../types/helia.DeleteBlockProgressEvents.html)
 [DeleteManyBlocksProgressEvents](../types/helia.DeleteManyBlocksProgressEvents.html)
 [GcEvents](../types/helia.GcEvents.html)
 [GetAllBlocksProgressEvents](../types/helia.GetAllBlocksProgressEvents.html)
 [GetBlockProgressEvents](../types/helia.GetBlockProgressEvents.html)
 [GetManyBlocksProgressEvents](../types/helia.GetManyBlocksProgressEvents.html)
 [HasBlockProgressEvents](../types/helia.HasBlockProgressEvents.html)
 [PinType](../types/helia.PinType.html)
 [PutBlockProgressEvents](../types/helia.PutBlockProgressEvents.html)
 [PutManyBlocksProgressEvents](../types/helia.PutManyBlocksProgressEvents.html)

### Variables

[DEFAULT\_SESSION\_MAX\_PROVIDERS](../variables/helia.DEFAULT_SESSION_MAX_PROVIDERS.html)
 [DEFAULT\_SESSION\_MIN\_PROVIDERS](../variables/helia.DEFAULT_SESSION_MIN_PROVIDERS.html)

### Functions

[createHelia](../functions/helia.createHelia.html)
 [libp2pDefaults](../functions/helia.libp2pDefaults.html)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[helia](#md:helia)
[About](#md:about)

*   [Example](#md:example)
    

[Install](#md:install)

*   [Browser <script> tag](#md:browser-ltscriptgt-tag)
    

[API Docs](#md:api-docs)
[License](#md:license)
[Contribute](#md:contribute)

---

# DAGCBOR | Helia

*   [Helia](../index.html)
    
*   [@helia/dag-cbor](../modules/_helia_dag_cbor.html)
    
*   [DAGCBOR](_helia_dag_cbor.DAGCBOR.html)
    

Interface DAGCBOR
=================

The JSON interface provides a simple and intuitive way to add/get objects with your Helia node and is a great place to start learning about IPFS.

interface DAGCBOR {  
    [add](_helia_dag_cbor.DAGCBOR.html#add.add-1)
(str, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>\>;  
    [get](_helia_dag_cbor.DAGCBOR.html#get.get-1)
<[T](_helia_dag_cbor.DAGCBOR.html#get.get-1.T)
\>(cid, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<[T](_helia_dag_cbor.DAGCBOR.html#get.get-1.T)
\>;  
}

##### Index

### Methods

[add](_helia_dag_cbor.DAGCBOR.html#add)
 [get](_helia_dag_cbor.DAGCBOR.html#get)

Methods
-------

### add[](#add)

*   add(str, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>[](#add.add-1)
    
*   Add an object to your Helia node and get a CID that refers to the block the object has been stored as.
    
    #### Parameters
    
    *   str: unknown
    *   `Optional` options: [Partial](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)
        <[AddOptions](_helia_dag_cbor.AddOptions.html)
        \>
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>
    
    #### Example
    
        import { dagCbor } from '@helia/dag-cbor'const d = dagCbor(helia)const cid = await d.add({ hello: 'world' })console.info(cid)// CID(bafyreidykglsfhoixmivffc5uwhcgshx4j465xwqntbmu43nb2dzqwfvae)
        
    

### get[](#get)

*   get<[T](_helia_dag_cbor.DAGCBOR.html#get.get-1.T)
    \>(cid, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[T](_helia_dag_cbor.DAGCBOR.html#get.get-1.T)
    \>[](#get.get-1)
    
*   Get an object from your Helia node, either previously added to it or to another node on the network.
    
    #### Type Parameters
    
    *   T
    
    #### Parameters
    
    *   cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [Partial](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)
        <[GetOptions](_helia_dag_cbor.GetOptions.html)
        \>
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[T](_helia_dag_cbor.DAGCBOR.html#get.get-1.T)
    \>
    
    #### Example
    
        import { createHelia } from 'helia'import { dagCbor } from '@helia/dag-cbor'import { CID } from 'multiformats/cid'const helia = await createHelia()const d = dagCbor(helia)const cid = CID.parse('bafyreidykglsfhoixmivffc5uwhcgshx4j465xwqntbmu43nb2dzqwfvae')const obj = await d.get(cid)console.info(obj)// { hello: 'world' }
        
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[add](#add)
[get](#get)

---

# DAGCBORComponents | Helia

*   [Helia](../index.html)
    
*   [@helia/dag-cbor](../modules/_helia_dag_cbor.html)
    
*   [DAGCBORComponents](_helia_dag_cbor.DAGCBORComponents.html)
    

Interface DAGCBORComponents
===========================

interface DAGCBORComponents {  
    [blockstore](_helia_dag_cbor.DAGCBORComponents.html#blockstore)
: [Blockstore](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Blockstore.html)
<{}, {}, {}, {}, {}, {}, {}, {}\>;  
}

##### Index

### Properties

[blockstore](_helia_dag_cbor.DAGCBORComponents.html#blockstore)

Properties
----------

### blockstore[](#blockstore)

blockstore: [Blockstore](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Blockstore.html)
<{}, {}, {}, {}, {}, {}, {}, {}\>

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[blockstore](#blockstore)

---

# GetOptions | Helia

*   [Helia](../index.html)
    
*   [@helia/dag-cbor](../modules/_helia_dag_cbor.html)
    
*   [GetOptions](_helia_dag_cbor.GetOptions.html)
    

Interface GetOptions
====================

interface GetOptions {  
    [codec](_helia_dag_cbor.GetOptions.html#codec)
: [BlockCodec](https://multiformats.github.io/js-multiformats/interfaces/codecs_interface.BlockCodec.html)
<any, unknown\>;  
    [onProgress](_helia_dag_cbor.GetOptions.html#onProgress)
?: ((evt) => void);  
    [signal](_helia_dag_cbor.GetOptions.html#signal)
?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)
;  
}

#### Hierarchy

*   [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
    
*   [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[GetBlockProgressEvents](../types/helia.GetBlockProgressEvents.html)
    \>
    *   GetOptions

##### Index

### Properties

[codec](_helia_dag_cbor.GetOptions.html#codec)
 [onProgress?](_helia_dag_cbor.GetOptions.html#onProgress)
 [signal?](_helia_dag_cbor.GetOptions.html#signal)

Properties
----------

### codec[](#codec)

codec: [BlockCodec](https://multiformats.github.io/js-multiformats/interfaces/codecs_interface.BlockCodec.html)
<any, unknown\>

### `Optional` onProgress[](#onProgress)

onProgress?: ((evt) => void)

#### Type declaration

*   *   (evt): void
    *   #### Parameters
        
        *   evt: [GetBlockProgressEvents](../types/helia.GetBlockProgressEvents.html)
            
        
        #### Returns void
        

### `Optional` signal[](#signal)

signal?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[codec](#codec)
[onProgress](#onProgress)
[signal](#signal)

---

# dagCbor | Helia

*   [Helia](../index.html)
    
*   [@helia/dag-cbor](../modules/_helia_dag_cbor.html)
    
*   [dagCbor](_helia_dag_cbor.dagCbor-1.html)
    

Function dagCbor
================

*   dagCbor(helia): [DAGCBOR](../interfaces/_helia_dag_cbor.DAGCBOR.html)
    [](#dagCbor)
    
*   Create a [DAGCBOR](../interfaces/_helia_dag_cbor.DAGCBOR.html)
     instance for use with [Helia](https://github.com/ipfs/helia)
    
    #### Parameters
    
    *   helia: {  
            blockstore: [Blockstore](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Blockstore.html)
        <{}, {}, {}, {}, {}, {}, {}, {}\>;  
        }
        *   ##### blockstore: [Blockstore](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Blockstore.html)
            <{}, {}, {}, {}, {}, {}, {}, {}\>
            
    
    #### Returns [DAGCBOR](../interfaces/_helia_dag_cbor.DAGCBOR.html)
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# Helia | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [Helia](helia.Helia.html)
    

Interface Helia
===============

The API presented by a Helia node

interface Helia {  
    [blockstore](helia.Helia.html#blockstore)
: [Blocks](helia.Blocks.html)
;  
    [datastore](helia.Helia.html#datastore)
: [Datastore](https://ipfs.github.io/js-stores/interfaces/interface_datastore.index.Datastore.html)
<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}\>;  
    [dns](helia.Helia.html#dns)
: [DNS](https://multiformats.github.io/js-dns/interfaces/index.DNS.html)
;  
    [getCodec](helia.Helia.html#getCodec)
: [CodecLoader](helia.CodecLoader.html)
;  
    [getHasher](helia.Helia.html#getHasher)
: [HasherLoader](helia.HasherLoader.html)
;  
    [logger](helia.Helia.html#logger)
: [ComponentLogger](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.ComponentLogger.html)
;  
    [metrics](helia.Helia.html#metrics)
?: [Metrics](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Metrics.html)
;  
    [pins](helia.Helia.html#pins)
: [Pins](helia.Pins.html)
;  
    [routing](helia.Helia.html#routing)
: [Routing](helia.Routing.html)
;  
    [gc](helia.Helia.html#gc.gc-1)
(options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<void\>;  
    [start](helia.Helia.html#start.start-1)
(): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<void\>;  
    [stop](helia.Helia.html#stop.stop-1)
(): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<void\>;  
}

#### Hierarchy ([view full](../hierarchy.html#helia.Helia)
)

*   Helia
    *   [HeliaLibp2p](helia.HeliaLibp2p.html)
        

#### Implemented by

##### Index

### Properties

[blockstore](helia.Helia.html#blockstore)
 [datastore](helia.Helia.html#datastore)
 [dns](helia.Helia.html#dns)
 [getCodec](helia.Helia.html#getCodec)
 [getHasher](helia.Helia.html#getHasher)
 [logger](helia.Helia.html#logger)
 [metrics?](helia.Helia.html#metrics)
 [pins](helia.Helia.html#pins)
 [routing](helia.Helia.html#routing)

### Methods

[gc](helia.Helia.html#gc)
 [start](helia.Helia.html#start)
 [stop](helia.Helia.html#stop)

Properties
----------

### blockstore[](#blockstore)

blockstore: [Blocks](helia.Blocks.html)

Where the blocks are stored

### datastore[](#datastore)

datastore: [Datastore](https://ipfs.github.io/js-stores/interfaces/interface_datastore.index.Datastore.html)
<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}\>

A key/value store

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

### dns[](#dns)

dns: [DNS](https://multiformats.github.io/js-dns/interfaces/index.DNS.html)

The DNS property can be used to perform lookups of various record types and will use a resolver appropriate to the current platform.

### getCodec[](#getCodec)

getCodec: [CodecLoader](helia.CodecLoader.html)

Load an IPLD codec. Implementations may return a promise if, for example, the codec is being fetched from the network.

### getHasher[](#getHasher)

getHasher: [HasherLoader](helia.HasherLoader.html)

Hashers can be used to hash a piece of data with the specified hashing algorithm. Implementations may return a promise if, for example, the hasher is being fetched from the network.

### logger[](#logger)

logger: [ComponentLogger](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.ComponentLogger.html)

A logging component that can be reused by consumers

### `Optional` metrics[](#metrics)

metrics?: [Metrics](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Metrics.html)

A metrics object that can be used to collected arbitrary stats about node usage.

### pins[](#pins)

pins: [Pins](helia.Pins.html)

Pinning operations for blocks in the blockstore

### routing[](#routing)

routing: [Routing](helia.Routing.html)

The routing component allows performing operations such as looking up content providers, information about peers, etc.

Methods
-------

### gc[](#gc)

*   gc(options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#gc.gc-1)
    
*   Remove any unpinned blocks from the blockstore
    
    #### Parameters
    
    *   `Optional` options: [GCOptions](helia.GCOptions.html)
        
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    

### start[](#start)

*   start(): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#start.start-1)
    
*   Starts the Helia node
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    

### stop[](#stop)

*   stop(): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#stop.stop-1)
    
*   Stops the Helia node
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[blockstore](#blockstore)
[datastore](#datastore)
[dns](#dns)
[getCodec](#getCodec)
[getHasher](#getHasher)
[logger](#logger)
[metrics](#metrics)
[pins](#pins)
[routing](#routing)
[gc](#gc)
[start](#start)
[stop](#stop)

---

# InsufficientProvidersError | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [InsufficientProvidersError](helia.InsufficientProvidersError.html)
    

Class InsufficientProvidersError
================================

#### Hierarchy

*   [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
    *   InsufficientProvidersError

##### Index

### Constructors

[constructor](helia.InsufficientProvidersError.html#constructor)

### Properties

[cause?](helia.InsufficientProvidersError.html#cause)
 [message](helia.InsufficientProvidersError.html#message)
 [name](helia.InsufficientProvidersError.html#name)
 [stack?](helia.InsufficientProvidersError.html#stack)
 [name](helia.InsufficientProvidersError.html#name-1)
 [prepareStackTrace?](helia.InsufficientProvidersError.html#prepareStackTrace)
 [stackTraceLimit](helia.InsufficientProvidersError.html#stackTraceLimit)

### Methods

[captureStackTrace](helia.InsufficientProvidersError.html#captureStackTrace)

Constructors
------------

### constructor[](#constructor)

*   new InsufficientProvidersError(message?): [InsufficientProvidersError](helia.InsufficientProvidersError.html)
    [](#constructor.new_InsufficientProvidersError)
    
*   #### Parameters
    
    *   `Optional` message: string
    
    #### Returns [InsufficientProvidersError](helia.InsufficientProvidersError.html)
    

Properties
----------

### `Optional` cause[](#cause)

cause?: unknown

### message[](#message)

message: string

### name[](#name)

name: string

### `Optional` stack[](#stack)

stack?: string

### `Static` name[](#name-1)

name: string

### `Static` `Optional` prepareStackTrace[](#prepareStackTrace)

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

#### Type declaration

*   *   (err, stackTraces): any
    *   #### Parameters
        
        *   err: [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
            
        *   stackTraces: [CallSite](https://www.npmjs.com/package/@types/node)
            \[\]
        
        #### Returns any
        

#### See

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

### `Static` stackTraceLimit[](#stackTraceLimit)

stackTraceLimit: number

Methods
-------

### `Static` captureStackTrace[](#captureStackTrace)

*   captureStackTrace(targetObject, constructorOpt?): void[](#captureStackTrace.captureStackTrace-1)
    
*   Create .stack property on a target object
    
    #### Parameters
    
    *   targetObject: object
    *   `Optional` constructorOpt: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function)
        
    
    #### Returns void
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[constructor](#constructor)
[cause](#cause)
[message](#message)
[name](#name)
[stack](#stack)
[name](#name-1)
[prepareStackTrace](#prepareStackTrace)
[stackTraceLimit](#stackTraceLimit)
[captureStackTrace](#captureStackTrace)

---

# NoRoutersAvailableError | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [NoRoutersAvailableError](helia.NoRoutersAvailableError.html)
    

Class NoRoutersAvailableError
=============================

#### Hierarchy

*   [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
    *   NoRoutersAvailableError

##### Index

### Constructors

[constructor](helia.NoRoutersAvailableError.html#constructor)

### Properties

[cause?](helia.NoRoutersAvailableError.html#cause)
 [message](helia.NoRoutersAvailableError.html#message)
 [name](helia.NoRoutersAvailableError.html#name)
 [stack?](helia.NoRoutersAvailableError.html#stack)
 [name](helia.NoRoutersAvailableError.html#name-1)
 [prepareStackTrace?](helia.NoRoutersAvailableError.html#prepareStackTrace)
 [stackTraceLimit](helia.NoRoutersAvailableError.html#stackTraceLimit)

### Methods

[captureStackTrace](helia.NoRoutersAvailableError.html#captureStackTrace)

Constructors
------------

### constructor[](#constructor)

*   new NoRoutersAvailableError(message?): [NoRoutersAvailableError](helia.NoRoutersAvailableError.html)
    [](#constructor.new_NoRoutersAvailableError)
    
*   #### Parameters
    
    *   `Optional` message: string
    
    #### Returns [NoRoutersAvailableError](helia.NoRoutersAvailableError.html)
    

Properties
----------

### `Optional` cause[](#cause)

cause?: unknown

### message[](#message)

message: string

### name[](#name)

name: string

### `Optional` stack[](#stack)

stack?: string

### `Static` name[](#name-1)

name: string

### `Static` `Optional` prepareStackTrace[](#prepareStackTrace)

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

#### Type declaration

*   *   (err, stackTraces): any
    *   #### Parameters
        
        *   err: [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
            
        *   stackTraces: [CallSite](https://www.npmjs.com/package/@types/node)
            \[\]
        
        #### Returns any
        

#### See

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

### `Static` stackTraceLimit[](#stackTraceLimit)

stackTraceLimit: number

Methods
-------

### `Static` captureStackTrace[](#captureStackTrace)

*   captureStackTrace(targetObject, constructorOpt?): void[](#captureStackTrace.captureStackTrace-1)
    
*   Create .stack property on a target object
    
    #### Parameters
    
    *   targetObject: object
    *   `Optional` constructorOpt: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function)
        
    
    #### Returns void
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[constructor](#constructor)
[cause](#cause)
[message](#message)
[name](#name)
[stack](#stack)
[name](#name-1)
[prepareStackTrace](#prepareStackTrace)
[stackTraceLimit](#stackTraceLimit)
[captureStackTrace](#captureStackTrace)

---

# UnknownCodecError | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [UnknownCodecError](helia.UnknownCodecError.html)
    

Class UnknownCodecError
=======================

#### Hierarchy

*   [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
    *   UnknownCodecError

##### Index

### Constructors

[constructor](helia.UnknownCodecError.html#constructor)

### Properties

[cause?](helia.UnknownCodecError.html#cause)
 [message](helia.UnknownCodecError.html#message)
 [name](helia.UnknownCodecError.html#name)
 [stack?](helia.UnknownCodecError.html#stack)
 [name](helia.UnknownCodecError.html#name-1)
 [prepareStackTrace?](helia.UnknownCodecError.html#prepareStackTrace)
 [stackTraceLimit](helia.UnknownCodecError.html#stackTraceLimit)

### Methods

[captureStackTrace](helia.UnknownCodecError.html#captureStackTrace)

Constructors
------------

### constructor[](#constructor)

*   new UnknownCodecError(message?): [UnknownCodecError](helia.UnknownCodecError.html)
    [](#constructor.new_UnknownCodecError)
    
*   #### Parameters
    
    *   `Optional` message: string
    
    #### Returns [UnknownCodecError](helia.UnknownCodecError.html)
    

Properties
----------

### `Optional` cause[](#cause)

cause?: unknown

### message[](#message)

message: string

### name[](#name)

name: string

### `Optional` stack[](#stack)

stack?: string

### `Static` name[](#name-1)

name: string

### `Static` `Optional` prepareStackTrace[](#prepareStackTrace)

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

#### Type declaration

*   *   (err, stackTraces): any
    *   #### Parameters
        
        *   err: [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
            
        *   stackTraces: [CallSite](https://www.npmjs.com/package/@types/node)
            \[\]
        
        #### Returns any
        

#### See

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

### `Static` stackTraceLimit[](#stackTraceLimit)

stackTraceLimit: number

Methods
-------

### `Static` captureStackTrace[](#captureStackTrace)

*   captureStackTrace(targetObject, constructorOpt?): void[](#captureStackTrace.captureStackTrace-1)
    
*   Create .stack property on a target object
    
    #### Parameters
    
    *   targetObject: object
    *   `Optional` constructorOpt: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function)
        
    
    #### Returns void
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[constructor](#constructor)
[cause](#cause)
[message](#message)
[name](#name)
[stack](#stack)
[name](#name-1)
[prepareStackTrace](#prepareStackTrace)
[stackTraceLimit](#stackTraceLimit)
[captureStackTrace](#captureStackTrace)

---

# UnknownHashAlgorithmError | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [UnknownHashAlgorithmError](helia.UnknownHashAlgorithmError.html)
    

Class UnknownHashAlgorithmError
===============================

#### Hierarchy

*   [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
    *   UnknownHashAlgorithmError

##### Index

### Constructors

[constructor](helia.UnknownHashAlgorithmError.html#constructor)

### Properties

[cause?](helia.UnknownHashAlgorithmError.html#cause)
 [message](helia.UnknownHashAlgorithmError.html#message)
 [name](helia.UnknownHashAlgorithmError.html#name)
 [stack?](helia.UnknownHashAlgorithmError.html#stack)
 [name](helia.UnknownHashAlgorithmError.html#name-1)
 [prepareStackTrace?](helia.UnknownHashAlgorithmError.html#prepareStackTrace)
 [stackTraceLimit](helia.UnknownHashAlgorithmError.html#stackTraceLimit)

### Methods

[captureStackTrace](helia.UnknownHashAlgorithmError.html#captureStackTrace)

Constructors
------------

### constructor[](#constructor)

*   new UnknownHashAlgorithmError(message?): [UnknownHashAlgorithmError](helia.UnknownHashAlgorithmError.html)
    [](#constructor.new_UnknownHashAlgorithmError)
    
*   #### Parameters
    
    *   `Optional` message: string
    
    #### Returns [UnknownHashAlgorithmError](helia.UnknownHashAlgorithmError.html)
    

Properties
----------

### `Optional` cause[](#cause)

cause?: unknown

### message[](#message)

message: string

### name[](#name)

name: string

### `Optional` stack[](#stack)

stack?: string

### `Static` name[](#name-1)

name: string

### `Static` `Optional` prepareStackTrace[](#prepareStackTrace)

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

#### Type declaration

*   *   (err, stackTraces): any
    *   #### Parameters
        
        *   err: [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
            
        *   stackTraces: [CallSite](https://www.npmjs.com/package/@types/node)
            \[\]
        
        #### Returns any
        

#### See

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

### `Static` stackTraceLimit[](#stackTraceLimit)

stackTraceLimit: number

Methods
-------

### `Static` captureStackTrace[](#captureStackTrace)

*   captureStackTrace(targetObject, constructorOpt?): void[](#captureStackTrace.captureStackTrace-1)
    
*   Create .stack property on a target object
    
    #### Parameters
    
    *   targetObject: object
    *   `Optional` constructorOpt: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function)
        
    
    #### Returns void
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[constructor](#constructor)
[cause](#cause)
[message](#message)
[name](#name)
[stack](#stack)
[name](#name-1)
[prepareStackTrace](#prepareStackTrace)
[stackTraceLimit](#stackTraceLimit)
[captureStackTrace](#captureStackTrace)

---

# BlockAnnounceOptions | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [BlockAnnounceOptions](helia.BlockAnnounceOptions.html)
    

Interface BlockAnnounceOptions<ProgressEvents>
==============================================

interface BlockAnnounceOptions<[ProgressEvents](helia.BlockAnnounceOptions.html#ProgressEvents)
\> {  
    [onProgress](helia.BlockAnnounceOptions.html#onProgress)
?: ((evt) => void);  
    [signal](helia.BlockAnnounceOptions.html#signal)
?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)
;  
}

#### Type Parameters

*   ProgressEvents extends [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
    <any, any\> = [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
    <any, any\>

#### Hierarchy

*   [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
    
*   [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[ProgressEvents](helia.BlockAnnounceOptions.html#ProgressEvents)
    \>
    *   BlockAnnounceOptions

##### Index

### Properties

[onProgress?](helia.BlockAnnounceOptions.html#onProgress)
 [signal?](helia.BlockAnnounceOptions.html#signal)

Properties
----------

### `Optional` onProgress[](#onProgress)

onProgress?: ((evt) => void)

#### Type declaration

*   *   (evt): void
    *   #### Parameters
        
        *   evt: [ProgressEvents](helia.BlockAnnounceOptions.html#ProgressEvents)
            
        
        #### Returns void
        

### `Optional` signal[](#signal)

signal?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[onProgress](#onProgress)
[signal](#signal)

---

# AddOptions | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [AddOptions](helia.AddOptions.html)
    

Interface AddOptions
====================

interface AddOptions {  
    [depth](helia.AddOptions.html#depth)
?: number;  
    [metadata](helia.AddOptions.html#metadata)
?: [Record](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)
<string, string | number | boolean\>;  
    [onProgress](helia.AddOptions.html#onProgress)
?: ((evt) => void);  
    [signal](helia.AddOptions.html#signal)
?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)
;  
}

#### Hierarchy

*   [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
    
*   [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[AddPinEvents](../types/helia.AddPinEvents.html)
     | [GetBlockProgressEvents](../types/helia.GetBlockProgressEvents.html)
    \>
    *   AddOptions

##### Index

### Properties

[depth?](helia.AddOptions.html#depth)
 [metadata?](helia.AddOptions.html#metadata)
 [onProgress?](helia.AddOptions.html#onProgress)
 [signal?](helia.AddOptions.html#signal)

Properties
----------

### `Optional` depth[](#depth)

depth?: number

How deeply to pin the DAG, defaults to Infinity

### `Optional` metadata[](#metadata)

metadata?: [Record](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)
<string, string | number | boolean\>

Optional user-defined metadata to store with the pin

### `Optional` onProgress[](#onProgress)

onProgress?: ((evt) => void)

#### Type declaration

*   *   (evt): void
    *   #### Parameters
        
        *   evt: [GetBlockProgressEvents](../types/helia.GetBlockProgressEvents.html)
             | [AddPinEvents](../types/helia.AddPinEvents.html)
            
        
        #### Returns void
        

### `Optional` signal[](#signal)

signal?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[depth](#depth)
[metadata](#metadata)
[onProgress](#onProgress)
[signal](#signal)

---

# BlockBroker | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [BlockBroker](helia.BlockBroker.html)
    

Interface BlockBroker<RetrieveProgressEvents, AnnounceProgressEvents>
=====================================================================

interface BlockBroker<[RetrieveProgressEvents](helia.BlockBroker.html#RetrieveProgressEvents)
, [AnnounceProgressEvents](helia.BlockBroker.html#AnnounceProgressEvents)
\> {  
    [announce](helia.BlockBroker.html#announce.announce-1)
?(cid, block, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<void\>;  
    [createSession](helia.BlockBroker.html#createSession.createSession-1)
?(options?): [BlockBroker](helia.BlockBroker.html)
<[RetrieveProgressEvents](helia.BlockBroker.html#RetrieveProgressEvents)
, [AnnounceProgressEvents](helia.BlockBroker.html#AnnounceProgressEvents)
\>;  
    [retrieve](helia.BlockBroker.html#retrieve.retrieve-1)
?(cid, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
\>;  
}

#### Type Parameters

*   RetrieveProgressEvents extends [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
    <any, any\> = [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
    <any, any\>
*   AnnounceProgressEvents extends [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
    <any, any\> = [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
    <any, any\>

#### Implemented by

##### Index

### Methods

[announce?](helia.BlockBroker.html#announce)
 [createSession?](helia.BlockBroker.html#createSession)
 [retrieve?](helia.BlockBroker.html#retrieve)

Methods
-------

### `Optional` announce[](#announce)

*   announce(cid, block, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#announce.announce-1)
    
*   Make a new block available to peers
    
    #### Parameters
    
    *   cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   block: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
        
    *   `Optional` options: [BlockAnnounceOptions](helia.BlockAnnounceOptions.html)
        <[AnnounceProgressEvents](helia.BlockBroker.html#AnnounceProgressEvents)
        \>
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    

### `Optional` createSession[](#createSession)

*   createSession(options?): [BlockBroker](helia.BlockBroker.html)
    <[RetrieveProgressEvents](helia.BlockBroker.html#RetrieveProgressEvents)
    , [AnnounceProgressEvents](helia.BlockBroker.html#AnnounceProgressEvents)
    \>[](#createSession.createSession-1)
    
*   Create a new session
    
    #### Parameters
    
    *   `Optional` options: [CreateSessionOptions](helia.CreateSessionOptions.html)
        <[RetrieveProgressEvents](helia.BlockBroker.html#RetrieveProgressEvents)
        \>
    
    #### Returns [BlockBroker](helia.BlockBroker.html)
    <[RetrieveProgressEvents](helia.BlockBroker.html#RetrieveProgressEvents)
    , [AnnounceProgressEvents](helia.BlockBroker.html#AnnounceProgressEvents)
    \>
    

### `Optional` retrieve[](#retrieve)

*   retrieve(cid, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    \>[](#retrieve.retrieve-1)
    
*   Retrieve a block from a source
    
    #### Parameters
    
    *   cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [BlockRetrievalOptions](helia.BlockRetrievalOptions.html)
        <[RetrieveProgressEvents](helia.BlockBroker.html#RetrieveProgressEvents)
        \>
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    \>
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[announce](#announce)
[createSession](#createSession)
[retrieve](#retrieve)

---

# BlockRetrievalOptions | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [BlockRetrievalOptions](helia.BlockRetrievalOptions.html)
    

Interface BlockRetrievalOptions<ProgressEvents>
===============================================

interface BlockRetrievalOptions<[ProgressEvents](helia.BlockRetrievalOptions.html#ProgressEvents)
\> {  
    [onProgress](helia.BlockRetrievalOptions.html#onProgress)
?: ((evt) => void);  
    [signal](helia.BlockRetrievalOptions.html#signal)
?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)
;  
    [validateFn](helia.BlockRetrievalOptions.html#validateFn.validateFn-1)
?(block): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<void\>;  
}

#### Type Parameters

*   ProgressEvents extends [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
    <any, any\> = [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
    <any, any\>

#### Hierarchy

*   [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
    
*   [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[ProgressEvents](helia.BlockRetrievalOptions.html#ProgressEvents)
    \>
    *   BlockRetrievalOptions

##### Index

### Properties

[onProgress?](helia.BlockRetrievalOptions.html#onProgress)
 [signal?](helia.BlockRetrievalOptions.html#signal)

### Methods

[validateFn?](helia.BlockRetrievalOptions.html#validateFn)

Properties
----------

### `Optional` onProgress[](#onProgress)

onProgress?: ((evt) => void)

#### Type declaration

*   *   (evt): void
    *   #### Parameters
        
        *   evt: [ProgressEvents](helia.BlockRetrievalOptions.html#ProgressEvents)
            
        
        #### Returns void
        

### `Optional` signal[](#signal)

signal?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)

Methods
-------

### `Optional` validateFn[](#validateFn)

*   validateFn(block): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#validateFn.validateFn-1)
    
*   A function that blockBrokers should call prior to returning a block to ensure it can maintain control of the block request flow. e.g. TrustedGatewayBlockBroker will use this to ensure that the block is valid from one of the gateways before assuming its work is done. If the block is not valid, it should try another gateway and WILL consider the gateway that returned the invalid blocks completely unreliable.
    
    #### Parameters
    
    *   block: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
        
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[onProgress](#onProgress)
[signal](#signal)
[validateFn](#validateFn)

---

# CodecLoader | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [CodecLoader](helia.CodecLoader.html)
    

Interface CodecLoader
=====================

interface CodecLoader (<[T](helia.CodecLoader.html#CodecLoader.T)
, [Code](helia.CodecLoader.html#CodecLoader.Code)
\>(code) => [Await](../types/helia.Await.html)
<[BlockCodec](https://multiformats.github.io/js-multiformats/interfaces/codecs_interface.BlockCodec.html)
<[Code](helia.CodecLoader.html#CodecLoader.Code)
, [T](helia.CodecLoader.html#CodecLoader.T)
\>\>)

*   CodecLoader<[T](helia.CodecLoader.html#CodecLoader.T)
    , [Code](helia.CodecLoader.html#CodecLoader.Code)
    \>(code): [Await](../types/helia.Await.html)
    <[BlockCodec](https://multiformats.github.io/js-multiformats/interfaces/codecs_interface.BlockCodec.html)
    <[Code](helia.CodecLoader.html#CodecLoader.Code)
    , [T](helia.CodecLoader.html#CodecLoader.T)
    \>\>[](#CodecLoader)
    
*   #### Type Parameters
    
    *   T = any
    *   Code extends number = any
    
    #### Parameters
    
    *   code: [Code](helia.CodecLoader.html#CodecLoader.Code)
        
    
    #### Returns [Await](../types/helia.Await.html)
    <[BlockCodec](https://multiformats.github.io/js-multiformats/interfaces/codecs_interface.BlockCodec.html)
    <[Code](helia.CodecLoader.html#CodecLoader.Code)
    , [T](helia.CodecLoader.html#CodecLoader.T)
    \>\>
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# Blocks | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [Blocks](helia.Blocks.html)
    

Interface Blocks
================

interface Blocks {  
    [createSession](helia.Blocks.html#createSession.createSession-1)
(root, options?): [SessionBlockstore](helia.SessionBlockstore.html)
;  
    [delete](helia.Blocks.html#delete.delete-1)
(key, options?): [Await](../types/helia.Await.html)
<void\>;  
    [deleteMany](helia.Blocks.html#deleteMany.deleteMany-1)
(source, options?): [AwaitIterable](../types/helia.AwaitIterable.html)
<[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>\>;  
    [get](helia.Blocks.html#get.get-1)
(key, options?): [Await](../types/helia.Await.html)
<[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
\>;  
    [getAll](helia.Blocks.html#getAll.getAll-1)
(options?): [AwaitIterable](../types/helia.AwaitIterable.html)
<[Pair](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Pair.html)
\>;  
    [getMany](helia.Blocks.html#getMany.getMany-1)
(source, options?): [AwaitIterable](../types/helia.AwaitIterable.html)
<[Pair](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Pair.html)
\>;  
    [has](helia.Blocks.html#has.has-1)
(key, options?): [Await](../types/helia.Await.html)
<boolean\>;  
    [put](helia.Blocks.html#put.put-1)
(key, val, options?): [Await](../types/helia.Await.html)
<[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>\>;  
    [putMany](helia.Blocks.html#putMany.putMany-1)
(source, options?): [AwaitIterable](../types/helia.AwaitIterable.html)
<[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>\>;  
}

#### Hierarchy

*   [Blockstore](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Blockstore.html)
    <[ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[HasBlockProgressEvents](../types/helia.HasBlockProgressEvents.html)
    \>, [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[PutBlockProgressEvents](../types/helia.PutBlockProgressEvents.html)
    \>, [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[PutManyBlocksProgressEvents](../types/helia.PutManyBlocksProgressEvents.html)
    \>, [GetOfflineOptions](helia.GetOfflineOptions.html)
     & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[GetBlockProgressEvents](../types/helia.GetBlockProgressEvents.html)
    \>, [GetOfflineOptions](helia.GetOfflineOptions.html)
     & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[GetManyBlocksProgressEvents](../types/helia.GetManyBlocksProgressEvents.html)
    \>, [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[GetAllBlocksProgressEvents](../types/helia.GetAllBlocksProgressEvents.html)
    \>, [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[DeleteBlockProgressEvents](../types/helia.DeleteBlockProgressEvents.html)
    \>, [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[DeleteManyBlocksProgressEvents](../types/helia.DeleteManyBlocksProgressEvents.html)
    \>\>
    *   Blocks

#### Implemented by

##### Index

### Methods

[createSession](helia.Blocks.html#createSession)
 [delete](helia.Blocks.html#delete)
 [deleteMany](helia.Blocks.html#deleteMany)
 [get](helia.Blocks.html#get)
 [getAll](helia.Blocks.html#getAll)
 [getMany](helia.Blocks.html#getMany)
 [has](helia.Blocks.html#has)
 [put](helia.Blocks.html#put)
 [putMany](helia.Blocks.html#putMany)

Methods
-------

### createSession[](#createSession)

*   createSession(root, options?): [SessionBlockstore](helia.SessionBlockstore.html)
    [](#createSession.createSession-1)
    
*   #### Parameters
    
    *   root: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [CreateSessionOptions](helia.CreateSessionOptions.html)
        <[GetBlockProgressEvents](../types/helia.GetBlockProgressEvents.html)
        \>
    
    #### Returns [SessionBlockstore](helia.SessionBlockstore.html)
    

### delete[](#delete)

*   delete(key, options?): [Await](../types/helia.Await.html)
    <void\>[](#delete.delete-1)
    
*   Remove the record for the passed key
    
    #### Parameters
    
    *   key: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[DeleteBlockProgressEvents](../types/helia.DeleteBlockProgressEvents.html)
        \>
    
    #### Returns [Await](../types/helia.Await.html)
    <void\>
    
    #### Example
    
        await store.delete(new Key('awesome'))console.log('deleted awesome content :(')
        
    

### deleteMany[](#deleteMany)

*   deleteMany(source, options?): [AwaitIterable](../types/helia.AwaitIterable.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>[](#deleteMany.deleteMany-1)
    
*   Remove values for the passed keys
    
    #### Parameters
    
    *   source: [AwaitIterable](../types/helia.AwaitIterable.html)
        <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>\>
    *   `Optional` options: [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[DeleteManyBlocksProgressEvents](../types/helia.DeleteManyBlocksProgressEvents.html)
        \>
    
    #### Returns [AwaitIterable](../types/helia.AwaitIterable.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>
    
    #### Example
    
        const source = [new Key('awesome')]for await (const key of store.deleteMany(source)) {  console.log(`deleted content with key ${key}`)}
        
    

### get[](#get)

*   get(key, options?): [Await](../types/helia.Await.html)
    <[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    \>[](#get.get-1)
    
*   Retrieve the value stored under the given key
    
    #### Parameters
    
    *   key: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
         & [GetOfflineOptions](helia.GetOfflineOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[GetBlockProgressEvents](../types/helia.GetBlockProgressEvents.html)
        \>
    
    #### Returns [Await](../types/helia.Await.html)
    <[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    \>
    
    #### Example
    
        const value = await store.get(new Key('awesome'))console.log('got content: %s', value.toString('utf8'))// => got content: datastore
        
    

### getAll[](#getAll)

*   getAll(options?): [AwaitIterable](../types/helia.AwaitIterable.html)
    <[Pair](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Pair.html)
    \>[](#getAll.getAll-1)
    
*   Retrieve all cid/block pairs from the blockstore as an unordered iterable
    
    #### Parameters
    
    *   `Optional` options: [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[GetAllBlocksProgressEvents](../types/helia.GetAllBlocksProgressEvents.html)
        \>
    
    #### Returns [AwaitIterable](../types/helia.AwaitIterable.html)
    <[Pair](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Pair.html)
    \>
    
    #### Example
    
        for await (const { multihash, block } of store.getAll()) {  console.log('got:', multihash, block)  // => got MultihashDigest('Qmfoo') Uint8Array[...]}
        
    

### getMany[](#getMany)

*   getMany(source, options?): [AwaitIterable](../types/helia.AwaitIterable.html)
    <[Pair](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Pair.html)
    \>[](#getMany.getMany-1)
    
*   Retrieve values for the passed keys
    
    #### Parameters
    
    *   source: [AwaitIterable](../types/helia.AwaitIterable.html)
        <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>\>
    *   `Optional` options: [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
         & [GetOfflineOptions](helia.GetOfflineOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[GetManyBlocksProgressEvents](../types/helia.GetManyBlocksProgressEvents.html)
        \>
    
    #### Returns [AwaitIterable](../types/helia.AwaitIterable.html)
    <[Pair](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Pair.html)
    \>
    
    #### Example
    
        for await (const { key, value } of store.getMany([new Key('awesome')])) {  console.log(`got "${key}" = "${new TextDecoder('utf8').decode(value)}"`')  // => got "/awesome" = "datastore"}
        
    

### has[](#has)

*   has(key, options?): [Await](../types/helia.Await.html)
    <boolean\>[](#has.has-1)
    
*   Check for the existence of a value for the passed key
    
    #### Parameters
    
    *   key: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[HasBlockProgressEvents](../types/helia.HasBlockProgressEvents.html)
        \>
    
    #### Returns [Await](../types/helia.Await.html)
    <boolean\>
    
    #### Example
    
        const exists = await store.has(new Key('awesome'))if (exists) { console.log('it is there')} else { console.log('it is not there')}
        
    

### put[](#put)

*   put(key, val, options?): [Await](../types/helia.Await.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>[](#put.put-1)
    
*   Store the passed value under the passed key
    
    #### Parameters
    
    *   key: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   val: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
        
    *   `Optional` options: [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[PutBlockProgressEvents](../types/helia.PutBlockProgressEvents.html)
        \>
    
    #### Returns [Await](../types/helia.Await.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>
    
    #### Example
    
        await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
        
    

### putMany[](#putMany)

*   putMany(source, options?): [AwaitIterable](../types/helia.AwaitIterable.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>[](#putMany.putMany-1)
    
*   Store the given key/value pairs
    
    #### Parameters
    
    *   source: [AwaitIterable](../types/helia.AwaitIterable.html)
        <[Pair](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Pair.html)
        \>
    *   `Optional` options: [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[PutManyBlocksProgressEvents](../types/helia.PutManyBlocksProgressEvents.html)
        \>
    
    #### Returns [AwaitIterable](../types/helia.AwaitIterable.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>
    
    #### Example
    
        const source = [{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }]for await (const { key, value } of store.putMany(source)) {  console.info(`put content for key ${key}`)}
        
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[createSession](#createSession)
[delete](#delete)
[deleteMany](#deleteMany)
[get](#get)
[getAll](#getAll)
[getMany](#getMany)
[has](#has)
[put](#put)
[putMany](#putMany)

---

# CreateSessionOptions | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [CreateSessionOptions](helia.CreateSessionOptions.html)
    

Interface CreateSessionOptions<ProgressEvents>
==============================================

interface CreateSessionOptions<[ProgressEvents](helia.CreateSessionOptions.html#ProgressEvents)
\> {  
    [maxProviders](helia.CreateSessionOptions.html#maxProviders)
?: number;  
    [minProviders](helia.CreateSessionOptions.html#minProviders)
?: number;  
    [onProgress](helia.CreateSessionOptions.html#onProgress)
?: ((evt) => void);  
    [signal](helia.CreateSessionOptions.html#signal)
?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)
;  
}

#### Type Parameters

*   ProgressEvents extends [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
    <any, any\> = [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
    <any, any\>

#### Hierarchy

*   [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
    
*   [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[ProgressEvents](helia.CreateSessionOptions.html#ProgressEvents)
    \>
    *   CreateSessionOptions
        

##### Index

### Properties

[maxProviders?](helia.CreateSessionOptions.html#maxProviders)
 [minProviders?](helia.CreateSessionOptions.html#minProviders)
 [onProgress?](helia.CreateSessionOptions.html#onProgress)
 [signal?](helia.CreateSessionOptions.html#signal)

Properties
----------

### `Optional` maxProviders[](#maxProviders)

maxProviders?: number

The maximum number of providers for the root CID to be added to a session.

#### Default

    5
    

### `Optional` minProviders[](#minProviders)

minProviders?: number

The minimum number of providers for the root CID that are required for successful session creation.

The session will become usable once this many providers have been discovered, up to `maxProviders` providers will continue to be added.

#### Default

    1
    

### `Optional` onProgress[](#onProgress)

onProgress?: ((evt) => void)

#### Type declaration

*   *   (evt): void
    *   #### Parameters
        
        *   evt: [ProgressEvents](helia.CreateSessionOptions.html#ProgressEvents)
            
        
        #### Returns void
        

### `Optional` signal[](#signal)

signal?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[maxProviders](#maxProviders)
[minProviders](#minProviders)
[onProgress](#onProgress)
[signal](#signal)

---

# DAGWalker | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [DAGWalker](helia.DAGWalker.html)
    

Interface DAGWalker
===================

DAGWalkers take a block and yield CIDs encoded in that block

interface DAGWalker {  
    [codec](helia.DAGWalker.html#codec)
: number;  
    [walk](helia.DAGWalker.html#walk.walk-1)
(block): [Generator](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Generator)
<[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>, void, undefined\>;  
}

##### Index

### Properties

[codec](helia.DAGWalker.html#codec)

### Methods

[walk](helia.DAGWalker.html#walk)

Properties
----------

### codec[](#codec)

codec: number

Methods
-------

### walk[](#walk)

*   walk(block): [Generator](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Generator)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>, void, undefined\>[](#walk.walk-1)
    
*   #### Parameters
    
    *   block: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
        
    
    #### Returns [Generator](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Generator)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>, void, undefined\>
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[codec](#codec)
[walk](#walk)

---

# DefaultLibp2pServices | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [DefaultLibp2pServices](helia.DefaultLibp2pServices.html)
    

Interface DefaultLibp2pServices
===============================

interface DefaultLibp2pServices {  
    [autoNAT](helia.DefaultLibp2pServices.html#autoNAT)
: unknown;  
    [autoTLS](helia.DefaultLibp2pServices.html#autoTLS)
: [AutoTLS](https://ipshipyard.github.io/js-libp2p-auto-tls/interfaces/AutoTLS.html)
;  
    [dcutr](helia.DefaultLibp2pServices.html#dcutr)
: unknown;  
    [delegatedRouting](helia.DefaultLibp2pServices.html#delegatedRouting)
: unknown;  
    [dht](helia.DefaultLibp2pServices.html#dht)
: [KadDHT](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_kad_dht.KadDHT.html)
;  
    [identify](helia.DefaultLibp2pServices.html#identify)
: [Identify](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_identify.Identify.html)
;  
    [keychain](helia.DefaultLibp2pServices.html#keychain)
: [Keychain](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_keychain.Keychain.html)
;  
    [ping](helia.DefaultLibp2pServices.html#ping)
: [PingService](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_ping.PingService.html)
;  
    [relay](helia.DefaultLibp2pServices.html#relay)
: [CircuitRelayService](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_circuit_relay_v2.CircuitRelayService.html)
;  
    [upnp](helia.DefaultLibp2pServices.html#upnp)
: unknown;  
}

#### Hierarchy

*   [Record](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)
    <string, unknown\>
    *   DefaultLibp2pServices

##### Index

### Properties

[autoNAT](helia.DefaultLibp2pServices.html#autoNAT)
 [autoTLS](helia.DefaultLibp2pServices.html#autoTLS)
 [dcutr](helia.DefaultLibp2pServices.html#dcutr)
 [delegatedRouting](helia.DefaultLibp2pServices.html#delegatedRouting)
 [dht](helia.DefaultLibp2pServices.html#dht)
 [identify](helia.DefaultLibp2pServices.html#identify)
 [keychain](helia.DefaultLibp2pServices.html#keychain)
 [ping](helia.DefaultLibp2pServices.html#ping)
 [relay](helia.DefaultLibp2pServices.html#relay)
 [upnp](helia.DefaultLibp2pServices.html#upnp)

Properties
----------

### autoNAT[](#autoNAT)

autoNAT: unknown

### autoTLS[](#autoTLS)

autoTLS: [AutoTLS](https://ipshipyard.github.io/js-libp2p-auto-tls/interfaces/AutoTLS.html)

### dcutr[](#dcutr)

dcutr: unknown

### delegatedRouting[](#delegatedRouting)

delegatedRouting: unknown

### dht[](#dht)

dht: [KadDHT](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_kad_dht.KadDHT.html)

### identify[](#identify)

identify: [Identify](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_identify.Identify.html)

### keychain[](#keychain)

keychain: [Keychain](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_keychain.Keychain.html)

### ping[](#ping)

ping: [PingService](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_ping.PingService.html)

### relay[](#relay)

relay: [CircuitRelayService](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_circuit_relay_v2.CircuitRelayService.html)

### upnp[](#upnp)

upnp: unknown

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[autoNAT](#autoNAT)
[autoTLS](#autoTLS)
[dcutr](#dcutr)
[delegatedRouting](#delegatedRouting)
[dht](#dht)
[identify](#identify)
[keychain](#keychain)
[ping](#ping)
[relay](#relay)
[upnp](#upnp)

---

# GCOptions | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [GCOptions](helia.GCOptions.html)
    

Interface GCOptions
===================

interface GCOptions {  
    [onProgress](helia.GCOptions.html#onProgress)
?: ((evt) => void);  
    [signal](helia.GCOptions.html#signal)
?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)
;  
}

#### Hierarchy

*   [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
    
*   [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[GcEvents](../types/helia.GcEvents.html)
    \>
    *   GCOptions

##### Index

### Properties

[onProgress?](helia.GCOptions.html#onProgress)
 [signal?](helia.GCOptions.html#signal)

Properties
----------

### `Optional` onProgress[](#onProgress)

onProgress?: ((evt) => void)

#### Type declaration

*   *   (evt): void
    *   #### Parameters
        
        *   evt: [GcEvents](../types/helia.GcEvents.html)
            
        
        #### Returns void
        

### `Optional` signal[](#signal)

signal?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[onProgress](#onProgress)
[signal](#signal)

---

# GetOfflineOptions | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [GetOfflineOptions](helia.GetOfflineOptions.html)
    

Interface GetOfflineOptions
===========================

interface GetOfflineOptions {  
    [offline](helia.GetOfflineOptions.html#offline)
?: boolean;  
}

##### Index

### Properties

[offline?](helia.GetOfflineOptions.html#offline)

Properties
----------

### `Optional` offline[](#offline)

offline?: boolean

If true, do not attempt to fetch any missing blocks from the network

#### Default

    false
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[offline](#offline)

---

# HasherLoader | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [HasherLoader](helia.HasherLoader.html)
    

Interface HasherLoader
======================

interface HasherLoader ((code) => [Await](../types/helia.Await.html)
<[MultihashHasher](https://multiformats.github.io/js-multiformats/interfaces/hashes_interface.MultihashHasher.html)
<number\>\>)

*   HasherLoader(code): [Await](../types/helia.Await.html)
    <[MultihashHasher](https://multiformats.github.io/js-multiformats/interfaces/hashes_interface.MultihashHasher.html)
    <number\>\>[](#HasherLoader)
    
*   #### Parameters
    
    *   code: number
    
    #### Returns [Await](../types/helia.Await.html)
    <[MultihashHasher](https://multiformats.github.io/js-multiformats/interfaces/hashes_interface.MultihashHasher.html)
    <number\>\>
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# Blockstore | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-blockstore](../modules/interface_blockstore.html)
    
*   [Blockstore](interface_blockstore.Blockstore.html)
    

Interface Blockstore<HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, GetAllOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension>
=================================================================================================================================================================================================================

interface Blockstore<[HasOptionsExtension](interface_blockstore.Blockstore.html#HasOptionsExtension)
, [PutOptionsExtension](interface_blockstore.Blockstore.html#PutOptionsExtension)
, [PutManyOptionsExtension](interface_blockstore.Blockstore.html#PutManyOptionsExtension)
, [GetOptionsExtension](interface_blockstore.Blockstore.html#GetOptionsExtension)
, [GetManyOptionsExtension](interface_blockstore.Blockstore.html#GetManyOptionsExtension)
, [GetAllOptionsExtension](interface_blockstore.Blockstore.html#GetAllOptionsExtension)
, [DeleteOptionsExtension](interface_blockstore.Blockstore.html#DeleteOptionsExtension)
, [DeleteManyOptionsExtension](interface_blockstore.Blockstore.html#DeleteManyOptionsExtension)
\> {  
    [delete](interface_blockstore.Blockstore.html#delete.delete-1)
(key, options?): [Await](../types/interface_store.Await.html)
<void\>;  
    [deleteMany](interface_blockstore.Blockstore.html#deleteMany.deleteMany-1)
(source, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
<[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>\>;  
    [get](interface_blockstore.Blockstore.html#get.get-1)
(key, options?): [Await](../types/interface_store.Await.html)
<[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
\>;  
    [getAll](interface_blockstore.Blockstore.html#getAll.getAll-1)
(options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
<[Pair](interface_blockstore.Pair.html)
\>;  
    [getMany](interface_blockstore.Blockstore.html#getMany.getMany-1)
(source, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
<[Pair](interface_blockstore.Pair.html)
\>;  
    [has](interface_blockstore.Blockstore.html#has.has-1)
(key, options?): [Await](../types/interface_store.Await.html)
<boolean\>;  
    [put](interface_blockstore.Blockstore.html#put.put-1)
(key, val, options?): [Await](../types/interface_store.Await.html)
<[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>\>;  
    [putMany](interface_blockstore.Blockstore.html#putMany.putMany-1)
(source, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
<[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>\>;  
}

#### Type Parameters

*   HasOptionsExtension = {}
*   PutOptionsExtension = {}
*   PutManyOptionsExtension = {}
*   GetOptionsExtension = {}
*   GetManyOptionsExtension = {}
*   GetAllOptionsExtension = {}
*   DeleteOptionsExtension = {}
*   DeleteManyOptionsExtension = {}

#### Hierarchy ([view full](../hierarchy.html#interface-blockstore.Blockstore)
)

*   [Store](interface_store.Store.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    , [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    , [Pair](interface_blockstore.Pair.html)
    , [HasOptionsExtension](interface_blockstore.Blockstore.html#HasOptionsExtension)
    , [PutOptionsExtension](interface_blockstore.Blockstore.html#PutOptionsExtension)
    , [PutManyOptionsExtension](interface_blockstore.Blockstore.html#PutManyOptionsExtension)
    , [GetOptionsExtension](interface_blockstore.Blockstore.html#GetOptionsExtension)
    , [GetManyOptionsExtension](interface_blockstore.Blockstore.html#GetManyOptionsExtension)
    , [DeleteOptionsExtension](interface_blockstore.Blockstore.html#DeleteOptionsExtension)
    , [DeleteManyOptionsExtension](interface_blockstore.Blockstore.html#DeleteManyOptionsExtension)
    \>
    *   Blockstore

#### Implemented by

##### Index

### Methods

[delete](interface_blockstore.Blockstore.html#delete)
 [deleteMany](interface_blockstore.Blockstore.html#deleteMany)
 [get](interface_blockstore.Blockstore.html#get)
 [getAll](interface_blockstore.Blockstore.html#getAll)
 [getMany](interface_blockstore.Blockstore.html#getMany)
 [has](interface_blockstore.Blockstore.html#has)
 [put](interface_blockstore.Blockstore.html#put)
 [putMany](interface_blockstore.Blockstore.html#putMany)

Methods
-------

### delete[](#delete)

*   delete(key, options?): [Await](../types/interface_store.Await.html)
    <void\>[](#delete.delete-1)
    
*   Remove the record for the passed key
    
    #### Parameters
    
    *   key: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [DeleteOptionsExtension](interface_blockstore.Blockstore.html#DeleteOptionsExtension)
        
    
    #### Returns [Await](../types/interface_store.Await.html)
    <void\>
    
    #### Example
    
        await store.delete(new Key('awesome'))console.log('deleted awesome content :(')
        
    

### deleteMany[](#deleteMany)

*   deleteMany(source, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>[](#deleteMany.deleteMany-1)
    
*   Remove values for the passed keys
    
    #### Parameters
    
    *   source: [AwaitIterable](../types/interface_store.AwaitIterable.html)
        <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>\>
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [DeleteManyOptionsExtension](interface_blockstore.Blockstore.html#DeleteManyOptionsExtension)
        
    
    #### Returns [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>
    
    #### Example
    
        const source = [new Key('awesome')]for await (const key of store.deleteMany(source)) {  console.log(`deleted content with key ${key}`)}
        
    

### get[](#get)

*   get(key, options?): [Await](../types/interface_store.Await.html)
    <[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    \>[](#get.get-1)
    
*   Retrieve the value stored under the given key
    
    #### Parameters
    
    *   key: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [GetOptionsExtension](interface_blockstore.Blockstore.html#GetOptionsExtension)
        
    
    #### Returns [Await](../types/interface_store.Await.html)
    <[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    \>
    
    #### Example
    
        const value = await store.get(new Key('awesome'))console.log('got content: %s', value.toString('utf8'))// => got content: datastore
        
    

### getAll[](#getAll)

*   getAll(options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Pair](interface_blockstore.Pair.html)
    \>[](#getAll.getAll-1)
    
*   Retrieve all cid/block pairs from the blockstore as an unordered iterable
    
    #### Parameters
    
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [GetAllOptionsExtension](interface_blockstore.Blockstore.html#GetAllOptionsExtension)
        
    
    #### Returns [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Pair](interface_blockstore.Pair.html)
    \>
    
    #### Example
    
        for await (const { multihash, block } of store.getAll()) {  console.log('got:', multihash, block)  // => got MultihashDigest('Qmfoo') Uint8Array[...]}
        
    

### getMany[](#getMany)

*   getMany(source, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Pair](interface_blockstore.Pair.html)
    \>[](#getMany.getMany-1)
    
*   Retrieve values for the passed keys
    
    #### Parameters
    
    *   source: [AwaitIterable](../types/interface_store.AwaitIterable.html)
        <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>\>
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [GetManyOptionsExtension](interface_blockstore.Blockstore.html#GetManyOptionsExtension)
        
    
    #### Returns [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Pair](interface_blockstore.Pair.html)
    \>
    
    #### Example
    
        for await (const { key, value } of store.getMany([new Key('awesome')])) {  console.log(`got "${key}" = "${new TextDecoder('utf8').decode(value)}"`')  // => got "/awesome" = "datastore"}
        
    

### has[](#has)

*   has(key, options?): [Await](../types/interface_store.Await.html)
    <boolean\>[](#has.has-1)
    
*   Check for the existence of a value for the passed key
    
    #### Parameters
    
    *   key: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [HasOptionsExtension](interface_blockstore.Blockstore.html#HasOptionsExtension)
        
    
    #### Returns [Await](../types/interface_store.Await.html)
    <boolean\>
    
    #### Example
    
        const exists = await store.has(new Key('awesome'))if (exists) { console.log('it is there')} else { console.log('it is not there')}
        
    

### put[](#put)

*   put(key, val, options?): [Await](../types/interface_store.Await.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>[](#put.put-1)
    
*   Store the passed value under the passed key
    
    #### Parameters
    
    *   key: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   val: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
        
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [PutOptionsExtension](interface_blockstore.Blockstore.html#PutOptionsExtension)
        
    
    #### Returns [Await](../types/interface_store.Await.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>
    
    #### Example
    
        await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
        
    

### putMany[](#putMany)

*   putMany(source, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>[](#putMany.putMany-1)
    
*   Store the given key/value pairs
    
    #### Parameters
    
    *   source: [AwaitIterable](../types/interface_store.AwaitIterable.html)
        <[Pair](interface_blockstore.Pair.html)
        \>
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [PutManyOptionsExtension](interface_blockstore.Blockstore.html#PutManyOptionsExtension)
        
    
    #### Returns [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>
    
    #### Example
    
        const source = [{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }]for await (const { key, value } of store.putMany(source)) {  console.info(`put content for key ${key}`)}
        
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[delete](#delete)
[deleteMany](#deleteMany)
[get](#get)
[getAll](#getAll)
[getMany](#getMany)
[has](#has)
[put](#put)
[putMany](#putMany)

---

# HeliaInit | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [HeliaInit](helia.HeliaInit.html)
    

Interface HeliaInit<T>
======================

Options used to create a Helia node.

interface HeliaInit<[T](helia.HeliaInit.html#T)
\> {  
    [blockBrokers](helia.HeliaInit.html#blockBrokers)
: ((components) => [BlockBroker](helia.BlockBroker.html)
<[ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<any, any\>, [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<any, any\>\>)\[\];  
    [blockstore](helia.HeliaInit.html#blockstore)
: [Blockstore](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Blockstore.html)
<{}, {}, {}, {}, {}, {}, {}, {}\>;  
    [codecs](helia.HeliaInit.html#codecs)
?: [BlockCodec](https://multiformats.github.io/js-multiformats/interfaces/codecs_interface.BlockCodec.html)
<any, any\>\[\];  
    [components](helia.HeliaInit.html#components)
?: [Record](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)
<string, any\>;  
    [datastore](helia.HeliaInit.html#datastore)
: [Datastore](https://ipfs.github.io/js-stores/interfaces/interface_datastore.index.Datastore.html)
<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}\>;  
    [dns](helia.HeliaInit.html#dns)
?: [DNS](https://multiformats.github.io/js-dns/interfaces/index.DNS.html)
;  
    [hashers](helia.HeliaInit.html#hashers)
?: [MultihashHasher](https://multiformats.github.io/js-multiformats/interfaces/hashes_interface.MultihashHasher.html)
<number\>\[\];  
    [holdGcLock](helia.HeliaInit.html#holdGcLock)
?: boolean;  
    [keychain](helia.HeliaInit.html#keychain)
?: [KeychainInit](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_keychain.KeychainInit.html)
;  
    [libp2p](helia.HeliaInit.html#libp2p)
?: [T](helia.HeliaInit.html#T)
 | [Omit](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)
<[Libp2pOptions](https://libp2p.github.io/js-libp2p/types/libp2p.index.Libp2pOptions.html)
<any\>, "start"\>;  
    [logger](helia.HeliaInit.html#logger)
?: [ComponentLogger](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.ComponentLogger.html)
;  
    [metrics](helia.HeliaInit.html#metrics)
?: [Metrics](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Metrics.html)
;  
    [providerLookupConcurrency](helia.HeliaInit.html#providerLookupConcurrency)
?: number;  
    [routers](helia.HeliaInit.html#routers)
?: [Partial](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)
<[Routing](helia.Routing.html)
\>\[\];  
    [start](helia.HeliaInit.html#start)
?: boolean;  
    [loadCodec](helia.HeliaInit.html#loadCodec.loadCodec-1)
?(code): [Await](../types/helia.Await.html)
<[BlockCodec](https://multiformats.github.io/js-multiformats/interfaces/codecs_interface.BlockCodec.html)
<any, any\>\>;  
    [loadHasher](helia.HeliaInit.html#loadHasher.loadHasher-1)
?(code): [Await](../types/helia.Await.html)
<[MultihashHasher](https://multiformats.github.io/js-multiformats/interfaces/hashes_interface.MultihashHasher.html)
<number\>\>;  
}

#### Type Parameters

*   T extends [Libp2p](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Libp2p.html)
     = [Libp2p](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Libp2p.html)
    

#### Hierarchy ([view full](../hierarchy.html#helia.HeliaInit)
)

*   [HeliaInit](_helia_utils.HeliaInit.html)
    *   HeliaInit

##### Index

### Properties

[blockBrokers](helia.HeliaInit.html#blockBrokers)
 [blockstore](helia.HeliaInit.html#blockstore)
 [codecs?](helia.HeliaInit.html#codecs)
 [components?](helia.HeliaInit.html#components)
 [datastore](helia.HeliaInit.html#datastore)
 [dns?](helia.HeliaInit.html#dns)
 [hashers?](helia.HeliaInit.html#hashers)
 [holdGcLock?](helia.HeliaInit.html#holdGcLock)
 [keychain?](helia.HeliaInit.html#keychain)
 [libp2p?](helia.HeliaInit.html#libp2p)
 [logger?](helia.HeliaInit.html#logger)
 [metrics?](helia.HeliaInit.html#metrics)
 [providerLookupConcurrency?](helia.HeliaInit.html#providerLookupConcurrency)
 [routers?](helia.HeliaInit.html#routers)
 [start?](helia.HeliaInit.html#start)

### Methods

[loadCodec?](helia.HeliaInit.html#loadCodec)
 [loadHasher?](helia.HeliaInit.html#loadHasher)

Properties
----------

### blockBrokers[](#blockBrokers)

blockBrokers: ((components) => [BlockBroker](helia.BlockBroker.html)
<[ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<any, any\>, [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<any, any\>\>)\[\]

A list of strategies used to fetch blocks when they are not present in the local blockstore

#### Type declaration

*   *   (components): [BlockBroker](helia.BlockBroker.html)
        <[ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
        <any, any\>, [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
        <any, any\>\>
    *   #### Parameters
        
        *   components: any
        
        #### Returns [BlockBroker](helia.BlockBroker.html)
        <[ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
        <any, any\>, [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
        <any, any\>\>
        

### blockstore[](#blockstore)

blockstore: [Blockstore](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Blockstore.html)
<{}, {}, {}, {}, {}, {}, {}, {}\>

The blockstore is where blocks are stored

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

### `Optional` codecs[](#codecs)

codecs?: [BlockCodec](https://multiformats.github.io/js-multiformats/interfaces/codecs_interface.BlockCodec.html)
<any, any\>\[\]

In order to pin CIDs that correspond to a DAG, it's necessary to know how to traverse that DAG. DAGWalkers take a block and yield any CIDs encoded within that block.

### `Optional` components[](#components)

components?: [Record](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)
<string, any\>

Components used by subclasses

### datastore[](#datastore)

datastore: [Datastore](https://ipfs.github.io/js-stores/interfaces/interface_datastore.index.Datastore.html)
<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}\>

The datastore is where data is stored

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

### `Optional` dns[](#dns)

dns?: [DNS](https://multiformats.github.io/js-dns/interfaces/index.DNS.html)

An optional DNS implementation used to perform queries for DNS records.

### `Optional` hashers[](#hashers)

hashers?: [MultihashHasher](https://multiformats.github.io/js-multiformats/interfaces/hashes_interface.MultihashHasher.html)
<number\>\[\]

By default sha256, sha512 and identity hashes are supported for bitswap operations. To bitswap blocks with CIDs using other hashes pass appropriate MultihashHashers here.

### `Optional` holdGcLock[](#holdGcLock)

holdGcLock?: boolean

Garbage collection requires preventing blockstore writes during searches for unpinned blocks as DAGs are typically pinned after they've been imported - without locking this could lead to the deletion of blocks while they are being added to the blockstore.

By default this lock is held on the current process and other processes will contact this process for access.

If Helia is being run in multiple processes, one process must hold the GC lock so use this option to control which process that is.

#### Default

    true
    

### `Optional` keychain[](#keychain)

keychain?: [KeychainInit](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_keychain.KeychainInit.html)

By default Helia stores the node's PeerId in an encrypted form in a libp2p keystore. These options control how that keystore is configured.

### `Optional` libp2p[](#libp2p)

libp2p?: [T](helia.HeliaInit.html#T)
 | [Omit](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)
<[Libp2pOptions](https://libp2p.github.io/js-libp2p/types/libp2p.index.Libp2pOptions.html)
<any\>, "start"\>

A libp2p node is required to perform network operations. Either a pre-configured node or options to configure a node can be passed here.

If node options are passed, they will be merged with the default config for the current platform. In this case all passed config keys will replace those from the default config.

The libp2p `start` option is not supported, instead please pass `start` in the root of the HeliaInit object.

### `Optional` logger[](#logger)

logger?: [ComponentLogger](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.ComponentLogger.html)

An optional logging component to pass to libp2p. If not specified the default implementation from libp2p will be used.

### `Optional` metrics[](#metrics)

metrics?: [Metrics](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Metrics.html)

A metrics object that can be used to collected arbitrary stats about node usage.

### `Optional` providerLookupConcurrency[](#providerLookupConcurrency)

providerLookupConcurrency?: number

During provider lookups, peers can be returned from routing implementations with no multiaddrs.

This can happen when they've been retrieved from network peers that only store multiaddrs for a limited amount of time.

When this happens the peer's info has to be looked up with a further query.

To not have this query block the yielding of other providers returned with multiaddrs, a separate queue is used to perform this lookup.

This config value controls the concurrency of that queue.

#### Default

    5
    

### `Optional` routers[](#routers)

routers?: [Partial](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)
<[Routing](helia.Routing.html)
\>\[\]

Routers perform operations such as looking up content providers, information about network peers or getting/putting records.

### `Optional` start[](#start)

start?: boolean

Pass `false` to not start the Helia node

Methods
-------

### `Optional` loadCodec[](#loadCodec)

*   loadCodec(code): [Await](../types/helia.Await.html)
    <[BlockCodec](https://multiformats.github.io/js-multiformats/interfaces/codecs_interface.BlockCodec.html)
    <any, any\>\>[](#loadCodec.loadCodec-1)
    
*   An optional function that can load a BlockCodec on demand. May return a promise.
    
    #### Parameters
    
    *   code: number
    
    #### Returns [Await](../types/helia.Await.html)
    <[BlockCodec](https://multiformats.github.io/js-multiformats/interfaces/codecs_interface.BlockCodec.html)
    <any, any\>\>
    

### `Optional` loadHasher[](#loadHasher)

*   loadHasher(code): [Await](../types/helia.Await.html)
    <[MultihashHasher](https://multiformats.github.io/js-multiformats/interfaces/hashes_interface.MultihashHasher.html)
    <number\>\>[](#loadHasher.loadHasher-1)
    
*   An optional function that can load a MultihashHasher on demand. May return a promise.
    
    #### Parameters
    
    *   code: number
    
    #### Returns [Await](../types/helia.Await.html)
    <[MultihashHasher](https://multiformats.github.io/js-multiformats/interfaces/hashes_interface.MultihashHasher.html)
    <number\>\>
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[blockBrokers](#blockBrokers)
[blockstore](#blockstore)
[codecs](#codecs)
[components](#components)
[datastore](#datastore)
[dns](#dns)
[hashers](#hashers)
[holdGcLock](#holdGcLock)
[keychain](#keychain)
[libp2p](#libp2p)
[logger](#logger)
[metrics](#metrics)
[providerLookupConcurrency](#providerLookupConcurrency)
[routers](#routers)
[start](#start)
[loadCodec](#loadCodec)
[loadHasher](#loadHasher)

---

# HeliaLibp2p | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [HeliaLibp2p](helia.HeliaLibp2p.html)
    

Interface HeliaLibp2p<T>
========================

The API presented by a Helia node

interface HeliaLibp2p<[T](helia.HeliaLibp2p.html#T)
\> {  
    [blockstore](helia.HeliaLibp2p.html#blockstore)
: [Blocks](helia.Blocks.html)
;  
    [datastore](helia.HeliaLibp2p.html#datastore)
: [Datastore](https://ipfs.github.io/js-stores/interfaces/interface_datastore.index.Datastore.html)
<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}\>;  
    [dns](helia.HeliaLibp2p.html#dns)
: [DNS](https://multiformats.github.io/js-dns/interfaces/index.DNS.html)
;  
    [getCodec](helia.HeliaLibp2p.html#getCodec)
: [CodecLoader](helia.CodecLoader.html)
;  
    [getHasher](helia.HeliaLibp2p.html#getHasher)
: [HasherLoader](helia.HasherLoader.html)
;  
    [libp2p](helia.HeliaLibp2p.html#libp2p)
: [T](helia.HeliaLibp2p.html#T)
;  
    [logger](helia.HeliaLibp2p.html#logger)
: [ComponentLogger](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.ComponentLogger.html)
;  
    [metrics](helia.HeliaLibp2p.html#metrics)
?: [Metrics](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Metrics.html)
;  
    [pins](helia.HeliaLibp2p.html#pins)
: [Pins](helia.Pins.html)
;  
    [routing](helia.HeliaLibp2p.html#routing)
: [Routing](helia.Routing.html)
;  
    [gc](helia.HeliaLibp2p.html#gc.gc-1)
(options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<void\>;  
    [start](helia.HeliaLibp2p.html#start.start-1)
(): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<void\>;  
    [stop](helia.HeliaLibp2p.html#stop.stop-1)
(): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<void\>;  
}

#### Type Parameters

*   T extends [Libp2p](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Libp2p.html)
     = [Libp2p](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Libp2p.html)
    <[DefaultLibp2pServices](helia.DefaultLibp2pServices.html)
    \>

#### Hierarchy ([view full](../hierarchy.html#helia.HeliaLibp2p)
)

*   [Helia](helia.Helia.html)
    *   HeliaLibp2p

##### Index

### Properties

[blockstore](helia.HeliaLibp2p.html#blockstore)
 [datastore](helia.HeliaLibp2p.html#datastore)
 [dns](helia.HeliaLibp2p.html#dns)
 [getCodec](helia.HeliaLibp2p.html#getCodec)
 [getHasher](helia.HeliaLibp2p.html#getHasher)
 [libp2p](helia.HeliaLibp2p.html#libp2p)
 [logger](helia.HeliaLibp2p.html#logger)
 [metrics?](helia.HeliaLibp2p.html#metrics)
 [pins](helia.HeliaLibp2p.html#pins)
 [routing](helia.HeliaLibp2p.html#routing)

### Methods

[gc](helia.HeliaLibp2p.html#gc)
 [start](helia.HeliaLibp2p.html#start)
 [stop](helia.HeliaLibp2p.html#stop)

Properties
----------

### blockstore[](#blockstore)

blockstore: [Blocks](helia.Blocks.html)

Where the blocks are stored

### datastore[](#datastore)

datastore: [Datastore](https://ipfs.github.io/js-stores/interfaces/interface_datastore.index.Datastore.html)
<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}\>

A key/value store

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

### dns[](#dns)

dns: [DNS](https://multiformats.github.io/js-dns/interfaces/index.DNS.html)

The DNS property can be used to perform lookups of various record types and will use a resolver appropriate to the current platform.

### getCodec[](#getCodec)

getCodec: [CodecLoader](helia.CodecLoader.html)

Load an IPLD codec. Implementations may return a promise if, for example, the codec is being fetched from the network.

### getHasher[](#getHasher)

getHasher: [HasherLoader](helia.HasherLoader.html)

Hashers can be used to hash a piece of data with the specified hashing algorithm. Implementations may return a promise if, for example, the hasher is being fetched from the network.

### libp2p[](#libp2p)

libp2p: [T](helia.HeliaLibp2p.html#T)

### logger[](#logger)

logger: [ComponentLogger](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.ComponentLogger.html)

A logging component that can be reused by consumers

### `Optional` metrics[](#metrics)

metrics?: [Metrics](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Metrics.html)

A metrics object that can be used to collected arbitrary stats about node usage.

### pins[](#pins)

pins: [Pins](helia.Pins.html)

Pinning operations for blocks in the blockstore

### routing[](#routing)

routing: [Routing](helia.Routing.html)

The routing component allows performing operations such as looking up content providers, information about peers, etc.

Methods
-------

### gc[](#gc)

*   gc(options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#gc.gc-1)
    
*   Remove any unpinned blocks from the blockstore
    
    #### Parameters
    
    *   `Optional` options: [GCOptions](helia.GCOptions.html)
        
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    

### start[](#start)

*   start(): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#start.start-1)
    
*   Starts the Helia node
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    

### stop[](#stop)

*   stop(): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#stop.stop-1)
    
*   Stops the Helia node
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[blockstore](#blockstore)
[datastore](#datastore)
[dns](#dns)
[getCodec](#getCodec)
[getHasher](#getHasher)
[libp2p](#libp2p)
[logger](#logger)
[metrics](#metrics)
[pins](#pins)
[routing](#routing)
[gc](#gc)
[start](#start)
[stop](#stop)

---

# IsPinnedOptions | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [IsPinnedOptions](helia.IsPinnedOptions.html)
    

Interface IsPinnedOptions
=========================

interface IsPinnedOptions {  
    [signal](helia.IsPinnedOptions.html#signal)
?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)
;  
}

#### Hierarchy

*   [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
    *   IsPinnedOptions

##### Index

### Properties

[signal?](helia.IsPinnedOptions.html#signal)

Properties
----------

### `Optional` signal[](#signal)

signal?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[signal](#signal)

---

# Libp2pDefaultsOptions | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [Libp2pDefaultsOptions](helia.Libp2pDefaultsOptions.html)
    

Interface Libp2pDefaultsOptions
===============================

interface Libp2pDefaultsOptions {  
    [dns](helia.Libp2pDefaultsOptions.html#dns)
?: [DNS](https://multiformats.github.io/js-dns/interfaces/index.DNS.html)
;  
    [keychain](helia.Libp2pDefaultsOptions.html#keychain)
?: [KeychainInit](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_keychain.KeychainInit.html)
;  
    [privateKey](helia.Libp2pDefaultsOptions.html#privateKey)
?: [PrivateKey](https://libp2p.github.io/js-libp2p/types/_libp2p_interface.PrivateKey.html)
;  
}

##### Index

### Properties

[dns?](helia.Libp2pDefaultsOptions.html#dns)
 [keychain?](helia.Libp2pDefaultsOptions.html#keychain)
 [privateKey?](helia.Libp2pDefaultsOptions.html#privateKey)

Properties
----------

### `Optional` dns[](#dns)

dns?: [DNS](https://multiformats.github.io/js-dns/interfaces/index.DNS.html)

### `Optional` keychain[](#keychain)

keychain?: [KeychainInit](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_keychain.KeychainInit.html)

### `Optional` privateKey[](#privateKey)

privateKey?: [PrivateKey](https://libp2p.github.io/js-libp2p/types/_libp2p_interface.PrivateKey.html)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[dns](#dns)
[keychain](#keychain)
[privateKey](#privateKey)

---

# GetBlockProgressEvents | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [GetBlockProgressEvents](helia.GetBlockProgressEvents.html)
    

Type alias GetBlockProgressEvents
=================================

GetBlockProgressEvents: [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"blocks:get:providers:want", [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
\> | [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"blocks:get:blockstore:get", [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
\> | [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"blocks:get:blockstore:put", [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
\>

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# LsOptions | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [LsOptions](helia.LsOptions.html)
    

Interface LsOptions
===================

interface LsOptions {  
    [cid](helia.LsOptions.html#cid)
?: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>;  
    [signal](helia.LsOptions.html#signal)
?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)
;  
}

#### Hierarchy

*   [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
    *   LsOptions

##### Index

### Properties

[cid?](helia.LsOptions.html#cid)
 [signal?](helia.LsOptions.html#signal)

Properties
----------

### `Optional` cid[](#cid)

cid?: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>

### `Optional` signal[](#signal)

signal?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[cid](#cid)
[signal](#signal)

---

# Pair | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [Pair](helia.Pair.html)
    

Interface Pair
==============

interface Pair {  
    [block](helia.Pair.html#block)
: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
;  
    [cid](helia.Pair.html#cid)
: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>;  
}

##### Index

### Properties

[block](helia.Pair.html#block)
 [cid](helia.Pair.html#cid)

Properties
----------

### block[](#block)

block: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)

### cid[](#cid)

cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[block](#block)
[cid](#cid)

---

# Pin | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [Pin](helia.Pin.html)
    

Interface Pin
=============

interface Pin {  
    [cid](helia.Pin.html#cid)
: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>;  
    [depth](helia.Pin.html#depth)
: number;  
    [metadata](helia.Pin.html#metadata)
: [Record](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)
<string, string | number | boolean\>;  
}

##### Index

### Properties

[cid](helia.Pin.html#cid)
 [depth](helia.Pin.html#depth)
 [metadata](helia.Pin.html#metadata)

Properties
----------

### cid[](#cid)

cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>

### depth[](#depth)

depth: number

### metadata[](#metadata)

metadata: [Record](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)
<string, string | number | boolean\>

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[cid](#cid)
[depth](#depth)
[metadata](#metadata)

---

# Pins | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [Pins](helia.Pins.html)
    

Interface Pins
==============

interface Pins {  
    [add](helia.Pins.html#add.add-1)
(cid, options?): [AsyncGenerator](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator)
<[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>, void, undefined\>;  
    [get](helia.Pins.html#get.get-1)
(cid, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<[Pin](helia.Pin.html)
\>;  
    [isPinned](helia.Pins.html#isPinned.isPinned-1)
(cid, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<boolean\>;  
    [ls](helia.Pins.html#ls.ls-1)
(options?): [AsyncGenerator](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator)
<[Pin](helia.Pin.html)
, void, undefined\>;  
    [rm](helia.Pins.html#rm.rm-1)
(cid, options?): [AsyncGenerator](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator)
<[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>, void, undefined\>;  
    [setMetadata](helia.Pins.html#setMetadata.setMetadata-1)
(cid, metadata, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<void\>;  
}

##### Index

### Methods

[add](helia.Pins.html#add)
 [get](helia.Pins.html#get)
 [isPinned](helia.Pins.html#isPinned)
 [ls](helia.Pins.html#ls)
 [rm](helia.Pins.html#rm)
 [setMetadata](helia.Pins.html#setMetadata)

Methods
-------

### add[](#add)

*   add(cid, options?): [AsyncGenerator](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>, void, undefined\>[](#add.add-1)
    
*   Pin a block in the blockstore. It will not be deleted when garbage collection is run.
    
    #### Parameters
    
    *   cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [AddOptions](helia.AddOptions.html)
        
    
    #### Returns [AsyncGenerator](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>, void, undefined\>
    

### get[](#get)

*   get(cid, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[Pin](helia.Pin.html)
    \>[](#get.get-1)
    
*   If the CID is pinned, return details of the pin, otherwise throw an error
    
    #### Parameters
    
    *   cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
        
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[Pin](helia.Pin.html)
    \>
    

### isPinned[](#isPinned)

*   isPinned(cid, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <boolean\>[](#isPinned.isPinned-1)
    
*   Return true if the passed CID is pinned
    
    #### Parameters
    
    *   cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [IsPinnedOptions](helia.IsPinnedOptions.html)
        
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <boolean\>
    

### ls[](#ls)

*   ls(options?): [AsyncGenerator](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator)
    <[Pin](helia.Pin.html)
    , void, undefined\>[](#ls.ls-1)
    
*   List all blocks that have been pinned.
    
    #### Parameters
    
    *   `Optional` options: [LsOptions](helia.LsOptions.html)
        
    
    #### Returns [AsyncGenerator](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator)
    <[Pin](helia.Pin.html)
    , void, undefined\>
    

### rm[](#rm)

*   rm(cid, options?): [AsyncGenerator](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>, void, undefined\>[](#rm.rm-1)
    
*   Unpin the block that corresponds to the passed CID. The block will be deleted when garbage collection is run.
    
    #### Parameters
    
    *   cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [RmOptions](helia.RmOptions.html)
        
    
    #### Returns [AsyncGenerator](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>, void, undefined\>
    

### setMetadata[](#setMetadata)

*   setMetadata(cid, metadata, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#setMetadata.setMetadata-1)
    
*   If the CID is pinned, update the metadata associated with the pin, otherwise throw an error
    
    #### Parameters
    
    *   cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   metadata: undefined | [Record](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)
        <string, string | number | boolean\>
    *   `Optional` options: [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
        
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[add](#add)
[get](#get)
[isPinned](#isPinned)
[ls](#ls)
[rm](#rm)
[setMetadata](#setMetadata)

---

# Provider | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [Provider](helia.Provider.html)
    

Interface Provider
==================

A provider can supply the content for a CID

interface Provider {  
    [id](helia.Provider.html#id)
: [PeerId](https://libp2p.github.io/js-libp2p/types/_libp2p_interface.PeerId.html)
;  
    [multiaddrs](helia.Provider.html#multiaddrs)
: [Multiaddr](https://multiformats.github.io/js-multiaddr/interfaces/index.Multiaddr.html)
\[\];  
    [protocols](helia.Provider.html#protocols)
?: string\[\];  
}

#### Hierarchy

*   [PeerInfo](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.PeerInfo.html)
    *   Provider

##### Index

### Properties

[id](helia.Provider.html#id)
 [multiaddrs](helia.Provider.html#multiaddrs)
 [protocols?](helia.Provider.html#protocols)

Properties
----------

### id[](#id)

id: [PeerId](https://libp2p.github.io/js-libp2p/types/_libp2p_interface.PeerId.html)

The identifier of the remote peer

### multiaddrs[](#multiaddrs)

multiaddrs: [Multiaddr](https://multiformats.github.io/js-multiaddr/interfaces/index.Multiaddr.html)
\[\]

The multiaddrs a peer is listening on

### `Optional` protocols[](#protocols)

protocols?: string\[\]

If present these are the methods that the peer can supply the content via.

If not present the caller should attempt to dial the remote peer and run the identify protocol to discover how to retrieve the content.

Example values are (but not limited to):

*   transport-graphsync-filecoinv1
*   transport-ipfs-gateway-http
*   transport-bitswap

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[id](#id)
[multiaddrs](#multiaddrs)
[protocols](#protocols)

---

# Routing | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [Routing](helia.Routing.html)
    

Interface Routing
=================

interface Routing {  
    [cancelReprovide](helia.Routing.html#cancelReprovide.cancelReprovide-1)
(key, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<void\>;  
    [findPeer](helia.Routing.html#findPeer.findPeer-1)
(peerId, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<[PeerInfo](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.PeerInfo.html)
\>;  
    [findProviders](helia.Routing.html#findProviders.findProviders-1)
(cid, options?): AsyncIterable<[Provider](helia.Provider.html)
\>;  
    [get](helia.Routing.html#get.get-1)
(key, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
\>;  
    [getClosestPeers](helia.Routing.html#getClosestPeers.getClosestPeers-1)
(key, options?): AsyncIterable<[PeerInfo](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.PeerInfo.html)
\>;  
    [provide](helia.Routing.html#provide.provide-1)
(cid, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<void\>;  
    [put](helia.Routing.html#put.put-1)
(key, value, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<void\>;  
}

##### Index

### Methods

[cancelReprovide](helia.Routing.html#cancelReprovide)
 [findPeer](helia.Routing.html#findPeer)
 [findProviders](helia.Routing.html#findProviders)
 [get](helia.Routing.html#get)
 [getClosestPeers](helia.Routing.html#getClosestPeers)
 [provide](helia.Routing.html#provide)
 [put](helia.Routing.html#put)

Methods
-------

### cancelReprovide[](#cancelReprovide)

*   cancelReprovide(key, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#cancelReprovide.cancelReprovide-1)
    
*   Helia will periodically re-provide every previously provided CID. Use this method to no longer re-provide the passed CID.
    
    #### Parameters
    
    *   key: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
        
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    
    #### Example
    
        // ...await contentRouting.cancelReprovide(cid)
        
    

### findPeer[](#findPeer)

*   findPeer(peerId, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[PeerInfo](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.PeerInfo.html)
    \>[](#findPeer.findPeer-1)
    
*   Searches the network for peer info corresponding to the passed peer id.
    
    #### Parameters
    
    *   peerId: [PeerId](https://libp2p.github.io/js-libp2p/types/_libp2p_interface.PeerId.html)
        
    *   `Optional` options: [RoutingOptions](helia.RoutingOptions.html)
        
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[PeerInfo](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.PeerInfo.html)
    \>
    
    #### Example
    
        // ...const peer = await peerRouting.findPeer(peerId, options)
        
    

### findProviders[](#findProviders)

*   findProviders(cid, options?): AsyncIterable<[Provider](helia.Provider.html)
    \>[](#findProviders.findProviders-1)
    
*   Find the providers of the passed CID.
    
    #### Parameters
    
    *   cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [RoutingOptions](helia.RoutingOptions.html)
        
    
    #### Returns AsyncIterable<[Provider](helia.Provider.html)
    \>
    
    #### Example
    
        // Iterate over the providers found for the given cidfor await (const provider of contentRouting.findProviders(cid)) { console.log(provider.id, provider.multiaddrs)}
        
    

### get[](#get)

*   get(key, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    \>[](#get.get-1)
    
*   Retrieves a value from the network corresponding to the passed key.
    
    #### Parameters
    
    *   key: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
        
    *   `Optional` options: [RoutingOptions](helia.RoutingOptions.html)
        
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    \>
    
    #### Example
    
        // ...const key = '/key'const value = await contentRouting.get(key)
        
    

### getClosestPeers[](#getClosestPeers)

*   getClosestPeers(key, options?): AsyncIterable<[PeerInfo](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.PeerInfo.html)
    \>[](#getClosestPeers.getClosestPeers-1)
    
*   Search the network for peers that are closer to the passed key. Peer info should be yielded in ever-increasing closeness to the key.
    
    #### Parameters
    
    *   key: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
        
    *   `Optional` options: [RoutingOptions](helia.RoutingOptions.html)
        
    
    #### Returns AsyncIterable<[PeerInfo](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.PeerInfo.html)
    \>
    
    #### Example
    
        // Iterate over the closest peers found for the given keyfor await (const peer of peerRouting.getClosestPeers(key)) {  console.log(peer.id, peer.multiaddrs)}
        
    

### provide[](#provide)

*   provide(cid, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#provide.provide-1)
    
*   The implementation of this method should ensure that network peers know the caller can provide content that corresponds to the passed CID.
    
    #### Parameters
    
    *   cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [RoutingOptions](helia.RoutingOptions.html)
        
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    
    #### Example
    
        // ...await contentRouting.provide(cid)
        
    

### put[](#put)

*   put(key, value, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#put.put-1)
    
*   Puts a value corresponding to the passed key in a way that can later be retrieved by another network peer using the get method.
    
    #### Parameters
    
    *   key: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
        
    *   value: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
        
    *   `Optional` options: [RoutingOptions](helia.RoutingOptions.html)
        
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    
    #### Example
    
        // ...const key = '/key'const value = uint8ArrayFromString('oh hello there')await contentRouting.put(key, value)
        
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[cancelReprovide](#cancelReprovide)
[findPeer](#findPeer)
[findProviders](#findProviders)
[get](#get)
[getClosestPeers](#getClosestPeers)
[provide](#provide)
[put](#put)

---

# RmOptions | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [RmOptions](helia.RmOptions.html)
    

Interface RmOptions
===================

interface RmOptions {  
    [signal](helia.RmOptions.html#signal)
?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)
;  
}

#### Hierarchy

*   [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
    *   RmOptions

##### Index

### Properties

[signal?](helia.RmOptions.html#signal)

Properties
----------

### `Optional` signal[](#signal)

signal?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[signal](#signal)

---

# RoutingOptions | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [RoutingOptions](helia.RoutingOptions.html)
    

Interface RoutingOptions
========================

When a routing operation involves reading values, these options allow controlling where the values are read from. Some implementations support a local cache that may be used in preference over network calls, for example when a record has a TTL.

interface RoutingOptions {  
    [onProgress](helia.RoutingOptions.html#onProgress)
?: ((evt) => void);  
    [signal](helia.RoutingOptions.html#signal)
?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)
;  
    [trace](helia.RoutingOptions.html#trace)
?: any;  
    [useCache](helia.RoutingOptions.html#useCache)
?: boolean;  
    [useNetwork](helia.RoutingOptions.html#useNetwork)
?: boolean;  
    [validate](helia.RoutingOptions.html#validate)
?: boolean;  
}

#### Hierarchy

*   [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
    
*   [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    
*   [TraceOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.TraceOptions.html)
    *   RoutingOptions

##### Index

### Properties

[onProgress?](helia.RoutingOptions.html#onProgress)
 [signal?](helia.RoutingOptions.html#signal)
 [trace?](helia.RoutingOptions.html#trace)
 [useCache?](helia.RoutingOptions.html#useCache)
 [useNetwork?](helia.RoutingOptions.html#useNetwork)
 [validate?](helia.RoutingOptions.html#validate)

Properties
----------

### `Optional` onProgress[](#onProgress)

onProgress?: ((evt) => void)

#### Type declaration

*   *   (evt): void
    *   #### Parameters
        
        *   evt: any
        
        #### Returns void
        

### `Optional` signal[](#signal)

signal?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)

### `Optional` trace[](#trace)

trace?: any

### `Optional` useCache[](#useCache)

useCache?: boolean

Pass `false` to not use cached values

#### Default

    true
    

### `Optional` useNetwork[](#useNetwork)

useNetwork?: boolean

Pass `false` to not use the network

#### Default

    true
    

### `Optional` validate[](#validate)

validate?: boolean

Pass `false` to not perform validation

#### Default

    true
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[onProgress](#onProgress)
[signal](#signal)
[trace](#trace)
[useCache](#useCache)
[useNetwork](#useNetwork)
[validate](#validate)

---

# SessionBlockstore | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [SessionBlockstore](helia.SessionBlockstore.html)
    

Interface SessionBlockstore
===========================

A session blockstore is a special blockstore that only pulls content from a subset of network peers which respond as having the block for the initial root CID.

Any blocks written to the blockstore as part of the session will propagate to the blockstore the session was created from.

interface SessionBlockstore {  
    [close](helia.SessionBlockstore.html#close.close-1)
(): void;  
    [delete](helia.SessionBlockstore.html#delete.delete-1)
(key, options?): [Await](../types/helia.Await.html)
<void\>;  
    [deleteMany](helia.SessionBlockstore.html#deleteMany.deleteMany-1)
(source, options?): [AwaitIterable](../types/helia.AwaitIterable.html)
<[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>\>;  
    [get](helia.SessionBlockstore.html#get.get-1)
(key, options?): [Await](../types/helia.Await.html)
<[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
\>;  
    [getAll](helia.SessionBlockstore.html#getAll.getAll-1)
(options?): [AwaitIterable](../types/helia.AwaitIterable.html)
<[Pair](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Pair.html)
\>;  
    [getMany](helia.SessionBlockstore.html#getMany.getMany-1)
(source, options?): [AwaitIterable](../types/helia.AwaitIterable.html)
<[Pair](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Pair.html)
\>;  
    [has](helia.SessionBlockstore.html#has.has-1)
(key, options?): [Await](../types/helia.Await.html)
<boolean\>;  
    [put](helia.SessionBlockstore.html#put.put-1)
(key, val, options?): [Await](../types/helia.Await.html)
<[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>\>;  
    [putMany](helia.SessionBlockstore.html#putMany.putMany-1)
(source, options?): [AwaitIterable](../types/helia.AwaitIterable.html)
<[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>\>;  
}

#### Hierarchy

*   [Blockstore](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Blockstore.html)
    <[ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[HasBlockProgressEvents](../types/helia.HasBlockProgressEvents.html)
    \>, [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[PutBlockProgressEvents](../types/helia.PutBlockProgressEvents.html)
    \>, [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[PutManyBlocksProgressEvents](../types/helia.PutManyBlocksProgressEvents.html)
    \>, [GetOfflineOptions](helia.GetOfflineOptions.html)
     & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[GetBlockProgressEvents](../types/helia.GetBlockProgressEvents.html)
    \>, [GetOfflineOptions](helia.GetOfflineOptions.html)
     & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[GetManyBlocksProgressEvents](../types/helia.GetManyBlocksProgressEvents.html)
    \>, [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[GetAllBlocksProgressEvents](../types/helia.GetAllBlocksProgressEvents.html)
    \>, [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[DeleteBlockProgressEvents](../types/helia.DeleteBlockProgressEvents.html)
    \>, [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
    <[DeleteManyBlocksProgressEvents](../types/helia.DeleteManyBlocksProgressEvents.html)
    \>\>
    *   SessionBlockstore

##### Index

### Methods

[close](helia.SessionBlockstore.html#close)
 [delete](helia.SessionBlockstore.html#delete)
 [deleteMany](helia.SessionBlockstore.html#deleteMany)
 [get](helia.SessionBlockstore.html#get)
 [getAll](helia.SessionBlockstore.html#getAll)
 [getMany](helia.SessionBlockstore.html#getMany)
 [has](helia.SessionBlockstore.html#has)
 [put](helia.SessionBlockstore.html#put)
 [putMany](helia.SessionBlockstore.html#putMany)

Methods
-------

### close[](#close)

*   close(): void[](#close.close-1)
    
*   Any in-progress operations will be aborted.
    
    #### Returns void
    

### delete[](#delete)

*   delete(key, options?): [Await](../types/helia.Await.html)
    <void\>[](#delete.delete-1)
    
*   Remove the record for the passed key
    
    #### Parameters
    
    *   key: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[DeleteBlockProgressEvents](../types/helia.DeleteBlockProgressEvents.html)
        \>
    
    #### Returns [Await](../types/helia.Await.html)
    <void\>
    
    #### Example
    
        await store.delete(new Key('awesome'))console.log('deleted awesome content :(')
        
    

### deleteMany[](#deleteMany)

*   deleteMany(source, options?): [AwaitIterable](../types/helia.AwaitIterable.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>[](#deleteMany.deleteMany-1)
    
*   Remove values for the passed keys
    
    #### Parameters
    
    *   source: [AwaitIterable](../types/helia.AwaitIterable.html)
        <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>\>
    *   `Optional` options: [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[DeleteManyBlocksProgressEvents](../types/helia.DeleteManyBlocksProgressEvents.html)
        \>
    
    #### Returns [AwaitIterable](../types/helia.AwaitIterable.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>
    
    #### Example
    
        const source = [new Key('awesome')]for await (const key of store.deleteMany(source)) {  console.log(`deleted content with key ${key}`)}
        
    

### get[](#get)

*   get(key, options?): [Await](../types/helia.Await.html)
    <[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    \>[](#get.get-1)
    
*   Retrieve the value stored under the given key
    
    #### Parameters
    
    *   key: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
         & [GetOfflineOptions](helia.GetOfflineOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[GetBlockProgressEvents](../types/helia.GetBlockProgressEvents.html)
        \>
    
    #### Returns [Await](../types/helia.Await.html)
    <[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    \>
    
    #### Example
    
        const value = await store.get(new Key('awesome'))console.log('got content: %s', value.toString('utf8'))// => got content: datastore
        
    

### getAll[](#getAll)

*   getAll(options?): [AwaitIterable](../types/helia.AwaitIterable.html)
    <[Pair](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Pair.html)
    \>[](#getAll.getAll-1)
    
*   Retrieve all cid/block pairs from the blockstore as an unordered iterable
    
    #### Parameters
    
    *   `Optional` options: [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[GetAllBlocksProgressEvents](../types/helia.GetAllBlocksProgressEvents.html)
        \>
    
    #### Returns [AwaitIterable](../types/helia.AwaitIterable.html)
    <[Pair](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Pair.html)
    \>
    
    #### Example
    
        for await (const { multihash, block } of store.getAll()) {  console.log('got:', multihash, block)  // => got MultihashDigest('Qmfoo') Uint8Array[...]}
        
    

### getMany[](#getMany)

*   getMany(source, options?): [AwaitIterable](../types/helia.AwaitIterable.html)
    <[Pair](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Pair.html)
    \>[](#getMany.getMany-1)
    
*   Retrieve values for the passed keys
    
    #### Parameters
    
    *   source: [AwaitIterable](../types/helia.AwaitIterable.html)
        <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>\>
    *   `Optional` options: [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
         & [GetOfflineOptions](helia.GetOfflineOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[GetManyBlocksProgressEvents](../types/helia.GetManyBlocksProgressEvents.html)
        \>
    
    #### Returns [AwaitIterable](../types/helia.AwaitIterable.html)
    <[Pair](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Pair.html)
    \>
    
    #### Example
    
        for await (const { key, value } of store.getMany([new Key('awesome')])) {  console.log(`got "${key}" = "${new TextDecoder('utf8').decode(value)}"`')  // => got "/awesome" = "datastore"}
        
    

### has[](#has)

*   has(key, options?): [Await](../types/helia.Await.html)
    <boolean\>[](#has.has-1)
    
*   Check for the existence of a value for the passed key
    
    #### Parameters
    
    *   key: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[HasBlockProgressEvents](../types/helia.HasBlockProgressEvents.html)
        \>
    
    #### Returns [Await](../types/helia.Await.html)
    <boolean\>
    
    #### Example
    
        const exists = await store.has(new Key('awesome'))if (exists) { console.log('it is there')} else { console.log('it is not there')}
        
    

### put[](#put)

*   put(key, val, options?): [Await](../types/helia.Await.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>[](#put.put-1)
    
*   Store the passed value under the passed key
    
    #### Parameters
    
    *   key: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   val: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
        
    *   `Optional` options: [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[PutBlockProgressEvents](../types/helia.PutBlockProgressEvents.html)
        \>
    
    #### Returns [Await](../types/helia.Await.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>
    
    #### Example
    
        await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
        
    

### putMany[](#putMany)

*   putMany(source, options?): [AwaitIterable](../types/helia.AwaitIterable.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>[](#putMany.putMany-1)
    
*   Store the given key/value pairs
    
    #### Parameters
    
    *   source: [AwaitIterable](../types/helia.AwaitIterable.html)
        <[Pair](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Pair.html)
        \>
    *   `Optional` options: [AbortOptions](https://ipfs.github.io/js-stores/interfaces/interface_store.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[PutManyBlocksProgressEvents](../types/helia.PutManyBlocksProgressEvents.html)
        \>
    
    #### Returns [AwaitIterable](../types/helia.AwaitIterable.html)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>
    
    #### Example
    
        const source = [{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }]for await (const { key, value } of store.putMany(source)) {  console.info(`put content for key ${key}`)}
        
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[close](#close)
[delete](#delete)
[deleteMany](#deleteMany)
[get](#get)
[getAll](#getAll)
[getMany](#getMany)
[has](#has)
[put](#put)
[putMany](#putMany)

---

# AddPinEvents | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [AddPinEvents](helia.AddPinEvents.html)
    

Type alias AddPinEvents
=======================

AddPinEvents: [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"helia:pin:add", [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
\>

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# Await | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [Await](helia.Await.html)
    

Type alias Await<T>
===================

Await<[T](helia.Await.html#T)
\>: [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<[T](helia.Await.html#T)
\> | [T](helia.Await.html#T)

A value or a promise of a value

#### Type Parameters

*   T

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# AwaitIterable | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [AwaitIterable](helia.AwaitIterable.html)
    

Type alias AwaitIterable<T>
===========================

AwaitIterable<[T](helia.AwaitIterable.html#T)
\>: [Iterable](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)
<[T](helia.AwaitIterable.html#T)
\> | AsyncIterable<[T](helia.AwaitIterable.html#T)
\>

An iterable or async iterable of values

#### Type Parameters

*   T

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# DeleteBlockProgressEvents | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [DeleteBlockProgressEvents](helia.DeleteBlockProgressEvents.html)
    

Type alias DeleteBlockProgressEvents
====================================

DeleteBlockProgressEvents: [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"blocks:delete:blockstore:delete", [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
\>

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# Datastore | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-datastore](../modules/interface_datastore.html)
    
*   [index](../modules/interface_datastore.index.html)
    
*   [Datastore](interface_datastore.index.Datastore.html)
    

Interface Datastore<HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension, QueryOptionsExtension, QueryKeysOptionsExtension, BatchOptionsExtension>
=================================================================================================================================================================================================================================================================

interface Datastore<[HasOptionsExtension](interface_datastore.index.Datastore.html#HasOptionsExtension)
, [PutOptionsExtension](interface_datastore.index.Datastore.html#PutOptionsExtension)
, [PutManyOptionsExtension](interface_datastore.index.Datastore.html#PutManyOptionsExtension)
, [GetOptionsExtension](interface_datastore.index.Datastore.html#GetOptionsExtension)
, [GetManyOptionsExtension](interface_datastore.index.Datastore.html#GetManyOptionsExtension)
, [DeleteOptionsExtension](interface_datastore.index.Datastore.html#DeleteOptionsExtension)
, [DeleteManyOptionsExtension](interface_datastore.index.Datastore.html#DeleteManyOptionsExtension)
, [QueryOptionsExtension](interface_datastore.index.Datastore.html#QueryOptionsExtension)
, [QueryKeysOptionsExtension](interface_datastore.index.Datastore.html#QueryKeysOptionsExtension)
, [BatchOptionsExtension](interface_datastore.index.Datastore.html#BatchOptionsExtension)
\> {  
    [batch](interface_datastore.index.Datastore.html#batch.batch-1)
(): [Batch](interface_datastore.index.Batch.html)
<[BatchOptionsExtension](interface_datastore.index.Datastore.html#BatchOptionsExtension)
\>;  
    [delete](interface_datastore.index.Datastore.html#delete.delete-1)
(key, options?): [Await](../types/interface_store.Await.html)
<void\>;  
    [deleteMany](interface_datastore.index.Datastore.html#deleteMany.deleteMany-1)
(source, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
<[Key](../classes/interface_datastore.key.Key.html)
\>;  
    [get](interface_datastore.index.Datastore.html#get.get-1)
(key, options?): [Await](../types/interface_store.Await.html)
<[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
\>;  
    [getMany](interface_datastore.index.Datastore.html#getMany.getMany-1)
(source, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
<[Pair](interface_datastore.index.Pair.html)
\>;  
    [has](interface_datastore.index.Datastore.html#has.has-1)
(key, options?): [Await](../types/interface_store.Await.html)
<boolean\>;  
    [put](interface_datastore.index.Datastore.html#put.put-1)
(key, val, options?): [Await](../types/interface_store.Await.html)
<[Key](../classes/interface_datastore.key.Key.html)
\>;  
    [putMany](interface_datastore.index.Datastore.html#putMany.putMany-1)
(source, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
<[Key](../classes/interface_datastore.key.Key.html)
\>;  
    [query](interface_datastore.index.Datastore.html#query.query-1)
(query, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
<[Pair](interface_datastore.index.Pair.html)
\>;  
    [queryKeys](interface_datastore.index.Datastore.html#queryKeys.queryKeys-1)
(query, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
<[Key](../classes/interface_datastore.key.Key.html)
\>;  
}

#### Type Parameters

*   HasOptionsExtension = {}
*   PutOptionsExtension = {}
*   PutManyOptionsExtension = {}
*   GetOptionsExtension = {}
*   GetManyOptionsExtension = {}
*   DeleteOptionsExtension = {}
*   DeleteManyOptionsExtension = {}
*   QueryOptionsExtension = {}
*   QueryKeysOptionsExtension = {}
*   BatchOptionsExtension = {}

#### Hierarchy ([view full](../hierarchy.html#interface-datastore.index.Datastore)
)

*   [Store](interface_store.Store.html)
    <[Key](../classes/interface_datastore.key.Key.html)
    , [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    , [Pair](interface_datastore.index.Pair.html)
    , [HasOptionsExtension](interface_datastore.index.Datastore.html#HasOptionsExtension)
    , [PutOptionsExtension](interface_datastore.index.Datastore.html#PutOptionsExtension)
    , [PutManyOptionsExtension](interface_datastore.index.Datastore.html#PutManyOptionsExtension)
    , [GetOptionsExtension](interface_datastore.index.Datastore.html#GetOptionsExtension)
    , [GetManyOptionsExtension](interface_datastore.index.Datastore.html#GetManyOptionsExtension)
    , [DeleteOptionsExtension](interface_datastore.index.Datastore.html#DeleteOptionsExtension)
    , [DeleteManyOptionsExtension](interface_datastore.index.Datastore.html#DeleteManyOptionsExtension)
    \>
    *   Datastore

#### Implemented by

##### Index

### Methods

[batch](interface_datastore.index.Datastore.html#batch)
 [delete](interface_datastore.index.Datastore.html#delete)
 [deleteMany](interface_datastore.index.Datastore.html#deleteMany)
 [get](interface_datastore.index.Datastore.html#get)
 [getMany](interface_datastore.index.Datastore.html#getMany)
 [has](interface_datastore.index.Datastore.html#has)
 [put](interface_datastore.index.Datastore.html#put)
 [putMany](interface_datastore.index.Datastore.html#putMany)
 [query](interface_datastore.index.Datastore.html#query)
 [queryKeys](interface_datastore.index.Datastore.html#queryKeys)

Methods
-------

### batch[](#batch)

*   batch(): [Batch](interface_datastore.index.Batch.html)
    <[BatchOptionsExtension](interface_datastore.index.Datastore.html#BatchOptionsExtension)
    \>[](#batch.batch-1)
    
*   This will return an object with which you can chain multiple operations together, with them only being executed on calling `commit`.
    
    #### Returns [Batch](interface_datastore.index.Batch.html)
    <[BatchOptionsExtension](interface_datastore.index.Datastore.html#BatchOptionsExtension)
    \>
    
    #### Example
    
        const b = store.batch()for (let i = 0; i < 100; i++) {  b.put(new Key(`hello${i}`), new TextEncoder('utf8').encode(`hello world ${i}`))}await b.commit()console.log('put 100 values')
        
    

### delete[](#delete)

*   delete(key, options?): [Await](../types/interface_store.Await.html)
    <void\>[](#delete.delete-1)
    
*   Remove the record for the passed key
    
    #### Parameters
    
    *   key: [Key](../classes/interface_datastore.key.Key.html)
        
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [DeleteOptionsExtension](interface_datastore.index.Datastore.html#DeleteOptionsExtension)
        
    
    #### Returns [Await](../types/interface_store.Await.html)
    <void\>
    
    #### Example
    
        await store.delete(new Key('awesome'))console.log('deleted awesome content :(')
        
    

### deleteMany[](#deleteMany)

*   deleteMany(source, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Key](../classes/interface_datastore.key.Key.html)
    \>[](#deleteMany.deleteMany-1)
    
*   Remove values for the passed keys
    
    #### Parameters
    
    *   source: [AwaitIterable](../types/interface_store.AwaitIterable.html)
        <[Key](../classes/interface_datastore.key.Key.html)
        \>
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [DeleteManyOptionsExtension](interface_datastore.index.Datastore.html#DeleteManyOptionsExtension)
        
    
    #### Returns [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Key](../classes/interface_datastore.key.Key.html)
    \>
    
    #### Example
    
        const source = [new Key('awesome')]for await (const key of store.deleteMany(source)) {  console.log(`deleted content with key ${key}`)}
        
    

### get[](#get)

*   get(key, options?): [Await](../types/interface_store.Await.html)
    <[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    \>[](#get.get-1)
    
*   Retrieve the value stored under the given key
    
    #### Parameters
    
    *   key: [Key](../classes/interface_datastore.key.Key.html)
        
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [GetOptionsExtension](interface_datastore.index.Datastore.html#GetOptionsExtension)
        
    
    #### Returns [Await](../types/interface_store.Await.html)
    <[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    \>
    
    #### Example
    
        const value = await store.get(new Key('awesome'))console.log('got content: %s', value.toString('utf8'))// => got content: datastore
        
    

### getMany[](#getMany)

*   getMany(source, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Pair](interface_datastore.index.Pair.html)
    \>[](#getMany.getMany-1)
    
*   Retrieve values for the passed keys
    
    #### Parameters
    
    *   source: [AwaitIterable](../types/interface_store.AwaitIterable.html)
        <[Key](../classes/interface_datastore.key.Key.html)
        \>
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [GetManyOptionsExtension](interface_datastore.index.Datastore.html#GetManyOptionsExtension)
        
    
    #### Returns [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Pair](interface_datastore.index.Pair.html)
    \>
    
    #### Example
    
        for await (const { key, value } of store.getMany([new Key('awesome')])) {  console.log(`got "${key}" = "${new TextDecoder('utf8').decode(value)}"`')  // => got "/awesome" = "datastore"}
        
    

### has[](#has)

*   has(key, options?): [Await](../types/interface_store.Await.html)
    <boolean\>[](#has.has-1)
    
*   Check for the existence of a value for the passed key
    
    #### Parameters
    
    *   key: [Key](../classes/interface_datastore.key.Key.html)
        
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [HasOptionsExtension](interface_datastore.index.Datastore.html#HasOptionsExtension)
        
    
    #### Returns [Await](../types/interface_store.Await.html)
    <boolean\>
    
    #### Example
    
        const exists = await store.has(new Key('awesome'))if (exists) { console.log('it is there')} else { console.log('it is not there')}
        
    

### put[](#put)

*   put(key, val, options?): [Await](../types/interface_store.Await.html)
    <[Key](../classes/interface_datastore.key.Key.html)
    \>[](#put.put-1)
    
*   Store the passed value under the passed key
    
    #### Parameters
    
    *   key: [Key](../classes/interface_datastore.key.Key.html)
        
    *   val: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
        
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [PutOptionsExtension](interface_datastore.index.Datastore.html#PutOptionsExtension)
        
    
    #### Returns [Await](../types/interface_store.Await.html)
    <[Key](../classes/interface_datastore.key.Key.html)
    \>
    
    #### Example
    
        await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
        
    

### putMany[](#putMany)

*   putMany(source, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Key](../classes/interface_datastore.key.Key.html)
    \>[](#putMany.putMany-1)
    
*   Store the given key/value pairs
    
    #### Parameters
    
    *   source: [AwaitIterable](../types/interface_store.AwaitIterable.html)
        <[Pair](interface_datastore.index.Pair.html)
        \>
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [PutManyOptionsExtension](interface_datastore.index.Datastore.html#PutManyOptionsExtension)
        
    
    #### Returns [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Key](../classes/interface_datastore.key.Key.html)
    \>
    
    #### Example
    
        const source = [{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }]for await (const { key, value } of store.putMany(source)) {  console.info(`put content for key ${key}`)}
        
    

### query[](#query)

*   query(query, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Pair](interface_datastore.index.Pair.html)
    \>[](#query.query-1)
    
*   Query the datastore.
    
    #### Parameters
    
    *   query: [Query](interface_datastore.index.Query.html)
        
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [QueryOptionsExtension](interface_datastore.index.Datastore.html#QueryOptionsExtension)
        
    
    #### Returns [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Pair](interface_datastore.index.Pair.html)
    \>
    
    #### Example
    
        // retrieve __all__ key/value pairs from the storelet list = []for await (const { key, value } of store.query({})) {  list.push(value)}console.log('ALL THE VALUES', list)
        
    

### queryKeys[](#queryKeys)

*   queryKeys(query, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Key](../classes/interface_datastore.key.Key.html)
    \>[](#queryKeys.queryKeys-1)
    
*   Query the datastore.
    
    #### Parameters
    
    *   query: [KeyQuery](interface_datastore.index.KeyQuery.html)
        
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [QueryKeysOptionsExtension](interface_datastore.index.Datastore.html#QueryKeysOptionsExtension)
        
    
    #### Returns [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Key](../classes/interface_datastore.key.Key.html)
    \>
    
    #### Example
    
        // retrieve __all__ keys from the storelet list = []for await (const key of store.queryKeys({})) {  list.push(key)}console.log('ALL THE KEYS', key)
        
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[batch](#batch)
[delete](#delete)
[deleteMany](#deleteMany)
[get](#get)
[getMany](#getMany)
[has](#has)
[put](#put)
[putMany](#putMany)
[query](#query)
[queryKeys](#queryKeys)

---

# DeleteManyBlocksProgressEvents | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [DeleteManyBlocksProgressEvents](helia.DeleteManyBlocksProgressEvents.html)
    

Type alias DeleteManyBlocksProgressEvents
=========================================

DeleteManyBlocksProgressEvents: [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"blocks:delete-many:blockstore:delete-many"\>

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# GcEvents | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [GcEvents](helia.GcEvents.html)
    

Type alias GcEvents
===================

GcEvents: [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"helia:gc:deleted", [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
\> | [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"helia:gc:error", [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
\>

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# GetAllBlocksProgressEvents | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [GetAllBlocksProgressEvents](helia.GetAllBlocksProgressEvents.html)
    

Type alias GetAllBlocksProgressEvents
=====================================

GetAllBlocksProgressEvents: [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"blocks:get-all:blockstore:get-many"\>

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# GetManyBlocksProgressEvents | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [GetManyBlocksProgressEvents](helia.GetManyBlocksProgressEvents.html)
    

Type alias GetManyBlocksProgressEvents
======================================

GetManyBlocksProgressEvents: [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"blocks:get-many:blockstore:get-many"\> | [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"blocks:get-many:providers:want", [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
\> | [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"blocks:get-many:blockstore:put", [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
\>

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# AbortOptions | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-store](../modules/interface_store.html)
    
*   [AbortOptions](interface_store.AbortOptions.html)
    

Interface AbortOptions
======================

Options for async operations.

interface AbortOptions {  
    [signal](interface_store.AbortOptions.html#signal)
?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)
;  
}

##### Index

### Properties

[signal?](interface_store.AbortOptions.html#signal)

Properties
----------

### `Optional` signal[](#signal)

signal?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[signal](#signal)

---

# HasBlockProgressEvents | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [HasBlockProgressEvents](helia.HasBlockProgressEvents.html)
    

Type alias HasBlockProgressEvents
=================================

HasBlockProgressEvents: [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"blocks:put:duplicate", [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
\> | [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"blocks:put:providers:notify", [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
\> | [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"blocks:put:blockstore:put", [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
\>

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# PinType | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [PinType](helia.PinType.html)
    

Type alias PinType
==================

PinType: "recursive" | "direct" | "indirect"

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# PutManyBlocksProgressEvents | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [PutManyBlocksProgressEvents](helia.PutManyBlocksProgressEvents.html)
    

Type alias PutManyBlocksProgressEvents
======================================

PutManyBlocksProgressEvents: [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"blocks:put-many:duplicate", [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
\> | [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"blocks:put-many:providers:notify", [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
\> | [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<"blocks:put-many:blockstore:put-many"\>

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# DEFAULT_SESSION_MIN_PROVIDERS | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [DEFAULT\_SESSION\_MIN\_PROVIDERS](helia.DEFAULT_SESSION_MIN_PROVIDERS.html)
    

Variable DEFAULT\_SESSION\_MIN\_PROVIDERS`Const`
================================================

DEFAULT\_SESSION\_MIN\_PROVIDERS: 1 = 1

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# DEFAULT_SESSION_MAX_PROVIDERS | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [DEFAULT\_SESSION\_MAX\_PROVIDERS](helia.DEFAULT_SESSION_MAX_PROVIDERS.html)
    

Variable DEFAULT\_SESSION\_MAX\_PROVIDERS`Const`
================================================

DEFAULT\_SESSION\_MAX\_PROVIDERS: 5 = 5

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# createHelia | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [createHelia](helia.createHelia.html)
    

Function createHelia
====================

*   createHelia<[T](helia.createHelia.html#createHelia.T)
    \>(init): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[HeliaLibp2p](../interfaces/helia.HeliaLibp2p.html)
    <[T](helia.createHelia.html#createHelia.T)
    \>\>[](#createHelia)
    
*   Create and return a Helia node
    
    #### Type Parameters
    
    *   T extends [Libp2p](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Libp2p.html)
        <[ServiceMap](https://libp2p.github.io/js-libp2p/types/_libp2p_interface.ServiceMap.html)
        \>
    
    #### Parameters
    
    *   init: [Partial](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)
        <[HeliaInit](../interfaces/helia.HeliaInit.html)
        <[T](helia.createHelia.html#createHelia.T)
        \>\>
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[HeliaLibp2p](../interfaces/helia.HeliaLibp2p.html)
    <[T](helia.createHelia.html#createHelia.T)
    \>\>
    
*   createHelia(init?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[HeliaLibp2p](../interfaces/helia.HeliaLibp2p.html)
    <[Libp2p](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Libp2p.html)
    <[DefaultLibp2pServices](../interfaces/helia.DefaultLibp2pServices.html)
    \>\>\>[](#createHelia-1)
    
*   #### Parameters
    
    *   `Optional` init: [Partial](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)
        <[HeliaInit](../interfaces/helia.HeliaInit.html)
        <[Libp2p](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Libp2p.html)
        <[DefaultLibp2pServices](../interfaces/helia.DefaultLibp2pServices.html)
        \>\>\>
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[HeliaLibp2p](../interfaces/helia.HeliaLibp2p.html)
    <[Libp2p](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Libp2p.html)
    <[DefaultLibp2pServices](../interfaces/helia.DefaultLibp2pServices.html)
    \>\>\>
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# Pair | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-blockstore](../modules/interface_blockstore.html)
    
*   [Pair](interface_blockstore.Pair.html)
    

Interface Pair
==============

interface Pair {  
    [block](interface_blockstore.Pair.html#block)
: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
;  
    [cid](interface_blockstore.Pair.html#cid)
: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>;  
}

##### Index

### Properties

[block](interface_blockstore.Pair.html#block)
 [cid](interface_blockstore.Pair.html#cid)

Properties
----------

### block[](#block)

block: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)

### cid[](#cid)

cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
<unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
\>

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[block](#block)
[cid](#cid)

---

# libp2pDefaults | Helia

*   [Helia](../index.html)
    
*   [helia](../modules/helia.html)
    
*   [libp2pDefaults](helia.libp2pDefaults.html)
    

Function libp2pDefaults
=======================

*   libp2pDefaults(options?): [Libp2pOptions](https://libp2p.github.io/js-libp2p/types/libp2p.index.Libp2pOptions.html)
    <[DefaultLibp2pServices](../interfaces/helia.DefaultLibp2pServices.html)
    \> & [Required](https://www.typescriptlang.org/docs/handbook/utility-types.html#requiredtype)
    <[Pick](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)
    <[Libp2pOptions](https://libp2p.github.io/js-libp2p/types/libp2p.index.Libp2pOptions.html)
    <[DefaultLibp2pServices](../interfaces/helia.DefaultLibp2pServices.html)
    \>, "services"\>\>[](#libp2pDefaults)
    
*   #### Parameters
    
    *   options: [Libp2pDefaultsOptions](../interfaces/helia.Libp2pDefaultsOptions.html)
         = {}
    
    #### Returns [Libp2pOptions](https://libp2p.github.io/js-libp2p/types/libp2p.index.Libp2pOptions.html)
    <[DefaultLibp2pServices](../interfaces/helia.DefaultLibp2pServices.html)
    \> & [Required](https://www.typescriptlang.org/docs/handbook/utility-types.html#requiredtype)
    <[Pick](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)
    <[Libp2pOptions](https://libp2p.github.io/js-libp2p/types/libp2p.index.Libp2pOptions.html)
    <[DefaultLibp2pServices](../interfaces/helia.DefaultLibp2pServices.html)
    \>, "services"\>\>
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# IPFS Stores

IPFS Stores
-----------

[stores](#md:stores)

=====================

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
 [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 [![codecov](https://img.shields.io/codecov/c/github/ipfs/js-stores.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-stores)
 [![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-stores/js-test-and-release.yml?branch=main&style=flat-square)](https://github.com/ipfs/js-stores/actions/workflows/js-test-and-release.yml?query=branch%3Amain)

> Blockstores and datastores used by IP-JS internals

[Packages](#md:packages)

=========================

*   [`packages/blockstore-core`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-core)
     Contains various implementations of the API contract described in interface-blockstore
*   [`packages/blockstore-fs`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-fs)
     Blockstore implementation with file system backend
*   [`packages/blockstore-idb`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-idb)
     Blockstore implementation with IndexedDB backend
*   [`packages/blockstore-level`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-level)
     Blockstore implementation with level(up|down) backend
*   [`packages/blockstore-s3`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-s3)
     IPFS blockstore implementation backed by s3
*   [`packages/datastore-core`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-core)
     Wrapper implementation for interface-datastore
*   [`packages/datastore-fs`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-fs)
     Datastore implementation with file system backend
*   [`packages/datastore-idb`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-idb)
     Datastore implementation with IndexedDB backend.
*   [`packages/datastore-level`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-level)
     Datastore implementation with level(up|down) backend
*   [`packages/datastore-s3`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-s3)
     IPFS datastore implementation backed by s3
*   [`packages/interface-blockstore`](https://github.com/ipfs/js-stores/tree/main/packages/interface-blockstore)
     An interface for storing and retrieving blocks
*   [`packages/interface-blockstore-tests`](https://github.com/ipfs/js-stores/tree/main/packages/interface-blockstore-tests)
     Compliance tests for the blockstore interface
*   [`packages/interface-datastore`](https://github.com/ipfs/js-stores/tree/main/packages/interface-datastore)
     datastore interface
*   [`packages/interface-datastore-tests`](https://github.com/ipfs/js-stores/tree/main/packages/interface-datastore-tests)
     Compliance tests for the datastore interface
*   [`packages/interface-store`](https://github.com/ipfs/js-stores/tree/main/packages/interface-store)
     A generic interface for storing and retrieving data

[API Docs](#md:api-docs)

=========================

*   [https://ipfs.github.io/js-stores](https://ipfs.github.io/js-stores)
    

[License](#md:license)

=======================

Licensed under either of

*   Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/js-stores/blob/main/LICENSE-APACHE)
     / [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
    )
*   MIT ([LICENSE-MIT](https://github.com/ipfs/js-stores/blob/main/LICENSE-MIT)
     / [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)
    )

[Contribute](#md:contribute)

=============================

Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-stores/issues)
.

Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md)
 for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md)
.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[stores](#md:stores)
[Packages](#md:packages)
[API Docs](#md:api-docs)
[License](#md:license)
[Contribute](#md:contribute)

---

# interface-blockstore | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-blockstore](interface_blockstore.html)
    

Module interface-blockstore
===========================

A Blockstore is a key/value database that lets use CIDs to store/retrieve binary blobs.

It is used by IPFS to store/retrieve the block that a given CID resolves to.

[Implementations](#md:implementations)

---------------------------------------

*   File System: [`blockstore-fs`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-fs)
    
*   IndexedDB: [`blockstore-idb`](https://github.com/ipfs/js-stores/blob/main/packages/blockstore-idb)
    
*   level: [`blockstore-level`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-level)
     (supports any levelup compatible backend)
*   Memory: [`blockstore-core/memory`](https://github.com/ipfs/js-stores/blob/main/packages/blockstore-core/src/memory.ts)
    
*   S3: [`blockstore-s3`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-s3)
    

[interface-blockstore](#md:interface-blockstore)

=================================================

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
 [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 [![codecov](https://img.shields.io/codecov/c/github/ipfs/js-stores.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-stores)
 [![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-stores/js-test-and-release.yml?branch=main&style=flat-square)](https://github.com/ipfs/js-stores/actions/workflows/js-test-and-release.yml?query=branch%3Amain)

> An interface for storing and retrieving blocks

[About](#md:about)

===================

A Blockstore is a key/value database that lets use CIDs to store/retrieve binary blobs.

It is used by IPFS to store/retrieve the block that a given CID resolves to.

[Implementations](#md:implementations)

---------------------------------------

*   File System: [`blockstore-fs`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-fs)
    
*   IndexedDB: [`blockstore-idb`](https://github.com/ipfs/js-stores/blob/main/packages/blockstore-idb)
    
*   level: [`blockstore-level`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-level)
     (supports any levelup compatible backend)
*   Memory: [`blockstore-core/memory`](https://github.com/ipfs/js-stores/blob/main/packages/blockstore-core/src/memory.ts)
    
*   S3: [`blockstore-s3`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-s3)
    

[Install](#md:install)

=======================

    $ npm i interface-blockstore
    

[API Docs](#md:api-docs)

=========================

*   [https://ipfs.github.io/js-stores/modules/interface\_blockstore.html](https://ipfs.github.io/js-stores/modules/interface_blockstore.html)
    

[License](#md:license)

=======================

Licensed under either of

*   Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/js-stores/blob/main/packages/interface-blockstore/LICENSE-APACHE)
     / [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
    )
*   MIT ([LICENSE-MIT](https://github.com/ipfs/js-stores/blob/main/packages/interface-blockstore/LICENSE-MIT)
     / [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)
    )

[Contribute](#md:contribute)

=============================

Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-stores/issues)
.

Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md)
 for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md)
.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

### Index

### Interfaces

[Blockstore](../interfaces/interface_blockstore.Blockstore.html)
 [Pair](../interfaces/interface_blockstore.Pair.html)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

*   [Implementations](#md:implementations)
    

[interface-blockstore](#md:interface-blockstore)
[About](#md:about)

*   [Implementations](#md:implementations)
    

[Install](#md:install)
[API Docs](#md:api-docs)
[License](#md:license)
[Contribute](#md:contribute)

---

# Await | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-store](../modules/interface_store.html)
    
*   [Await](interface_store.Await.html)
    

Type alias Await<T>
===================

Await<[T](interface_store.Await.html#T)
\>: [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<[T](interface_store.Await.html#T)
\> | [T](interface_store.Await.html#T)

A value or a promise of a value

#### Type Parameters

*   T

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# HeliaInit | Helia

*   [Helia](../index.html)
    
*   [@helia/utils](../modules/_helia_utils.html)
    
*   [HeliaInit](_helia_utils.HeliaInit.html)
    

Interface HeliaInit
===================

Options used to create a Helia node.

interface HeliaInit {  
    [blockBrokers](_helia_utils.HeliaInit.html#blockBrokers)
: ((components) => [BlockBroker](helia.BlockBroker.html)
<[ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<any, any\>, [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<any, any\>\>)\[\];  
    [blockstore](_helia_utils.HeliaInit.html#blockstore)
: [Blockstore](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Blockstore.html)
<{}, {}, {}, {}, {}, {}, {}, {}\>;  
    [codecs](_helia_utils.HeliaInit.html#codecs)
?: [BlockCodec](https://multiformats.github.io/js-multiformats/interfaces/codecs_interface.BlockCodec.html)
<any, any\>\[\];  
    [components](_helia_utils.HeliaInit.html#components)
?: [Record](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)
<string, any\>;  
    [datastore](_helia_utils.HeliaInit.html#datastore)
: [Datastore](https://ipfs.github.io/js-stores/interfaces/interface_datastore.index.Datastore.html)
<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}\>;  
    [dns](_helia_utils.HeliaInit.html#dns)
?: [DNS](https://multiformats.github.io/js-dns/interfaces/index.DNS.html)
;  
    [hashers](_helia_utils.HeliaInit.html#hashers)
?: [MultihashHasher](https://multiformats.github.io/js-multiformats/interfaces/hashes_interface.MultihashHasher.html)
<number\>\[\];  
    [holdGcLock](_helia_utils.HeliaInit.html#holdGcLock)
?: boolean;  
    [logger](_helia_utils.HeliaInit.html#logger)
?: [ComponentLogger](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.ComponentLogger.html)
;  
    [metrics](_helia_utils.HeliaInit.html#metrics)
?: [Metrics](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Metrics.html)
;  
    [providerLookupConcurrency](_helia_utils.HeliaInit.html#providerLookupConcurrency)
?: number;  
    [routers](_helia_utils.HeliaInit.html#routers)
?: [Partial](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)
<[Routing](helia.Routing.html)
\>\[\];  
    [loadCodec](_helia_utils.HeliaInit.html#loadCodec.loadCodec-1)
?(code): [Await](../types/helia.Await.html)
<[BlockCodec](https://multiformats.github.io/js-multiformats/interfaces/codecs_interface.BlockCodec.html)
<any, any\>\>;  
    [loadHasher](_helia_utils.HeliaInit.html#loadHasher.loadHasher-1)
?(code): [Await](../types/helia.Await.html)
<[MultihashHasher](https://multiformats.github.io/js-multiformats/interfaces/hashes_interface.MultihashHasher.html)
<number\>\>;  
}

#### Hierarchy

*   HeliaInit
    

##### Index

### Properties

[blockBrokers](_helia_utils.HeliaInit.html#blockBrokers)
 [blockstore](_helia_utils.HeliaInit.html#blockstore)
 [codecs?](_helia_utils.HeliaInit.html#codecs)
 [components?](_helia_utils.HeliaInit.html#components)
 [datastore](_helia_utils.HeliaInit.html#datastore)
 [dns?](_helia_utils.HeliaInit.html#dns)
 [hashers?](_helia_utils.HeliaInit.html#hashers)
 [holdGcLock?](_helia_utils.HeliaInit.html#holdGcLock)
 [logger?](_helia_utils.HeliaInit.html#logger)
 [metrics?](_helia_utils.HeliaInit.html#metrics)
 [providerLookupConcurrency?](_helia_utils.HeliaInit.html#providerLookupConcurrency)
 [routers?](_helia_utils.HeliaInit.html#routers)

### Methods

[loadCodec?](_helia_utils.HeliaInit.html#loadCodec)
 [loadHasher?](_helia_utils.HeliaInit.html#loadHasher)

Properties
----------

### blockBrokers[](#blockBrokers)

blockBrokers: ((components) => [BlockBroker](helia.BlockBroker.html)
<[ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<any, any\>, [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
<any, any\>\>)\[\]

A list of strategies used to fetch blocks when they are not present in the local blockstore

#### Type declaration

*   *   (components): [BlockBroker](helia.BlockBroker.html)
        <[ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
        <any, any\>, [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
        <any, any\>\>
    *   #### Parameters
        
        *   components: any
        
        #### Returns [BlockBroker](helia.BlockBroker.html)
        <[ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
        <any, any\>, [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
        <any, any\>\>
        

### blockstore[](#blockstore)

blockstore: [Blockstore](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Blockstore.html)
<{}, {}, {}, {}, {}, {}, {}, {}\>

The blockstore is where blocks are stored

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

### `Optional` codecs[](#codecs)

codecs?: [BlockCodec](https://multiformats.github.io/js-multiformats/interfaces/codecs_interface.BlockCodec.html)
<any, any\>\[\]

In order to pin CIDs that correspond to a DAG, it's necessary to know how to traverse that DAG. DAGWalkers take a block and yield any CIDs encoded within that block.

### `Optional` components[](#components)

components?: [Record](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)
<string, any\>

Components used by subclasses

### datastore[](#datastore)

datastore: [Datastore](https://ipfs.github.io/js-stores/interfaces/interface_datastore.index.Datastore.html)
<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}\>

The datastore is where data is stored

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

### `Optional` dns[](#dns)

dns?: [DNS](https://multiformats.github.io/js-dns/interfaces/index.DNS.html)

An optional DNS implementation used to perform queries for DNS records.

### `Optional` hashers[](#hashers)

hashers?: [MultihashHasher](https://multiformats.github.io/js-multiformats/interfaces/hashes_interface.MultihashHasher.html)
<number\>\[\]

By default sha256, sha512 and identity hashes are supported for bitswap operations. To bitswap blocks with CIDs using other hashes pass appropriate MultihashHashers here.

### `Optional` holdGcLock[](#holdGcLock)

holdGcLock?: boolean

Garbage collection requires preventing blockstore writes during searches for unpinned blocks as DAGs are typically pinned after they've been imported - without locking this could lead to the deletion of blocks while they are being added to the blockstore.

By default this lock is held on the current process and other processes will contact this process for access.

If Helia is being run in multiple processes, one process must hold the GC lock so use this option to control which process that is.

#### Default

    true
    

### `Optional` logger[](#logger)

logger?: [ComponentLogger](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.ComponentLogger.html)

An optional logging component to pass to libp2p. If not specified the default implementation from libp2p will be used.

### `Optional` metrics[](#metrics)

metrics?: [Metrics](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Metrics.html)

A metrics object that can be used to collected arbitrary stats about node usage.

### `Optional` providerLookupConcurrency[](#providerLookupConcurrency)

providerLookupConcurrency?: number

During provider lookups, peers can be returned from routing implementations with no multiaddrs.

This can happen when they've been retrieved from network peers that only store multiaddrs for a limited amount of time.

When this happens the peer's info has to be looked up with a further query.

To not have this query block the yielding of other providers returned with multiaddrs, a separate queue is used to perform this lookup.

This config value controls the concurrency of that queue.

#### Default

    5
    

### `Optional` routers[](#routers)

routers?: [Partial](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)
<[Routing](helia.Routing.html)
\>\[\]

Routers perform operations such as looking up content providers, information about network peers or getting/putting records.

Methods
-------

### `Optional` loadCodec[](#loadCodec)

*   loadCodec(code): [Await](../types/helia.Await.html)
    <[BlockCodec](https://multiformats.github.io/js-multiformats/interfaces/codecs_interface.BlockCodec.html)
    <any, any\>\>[](#loadCodec.loadCodec-1)
    
*   An optional function that can load a BlockCodec on demand. May return a promise.
    
    #### Parameters
    
    *   code: number
    
    #### Returns [Await](../types/helia.Await.html)
    <[BlockCodec](https://multiformats.github.io/js-multiformats/interfaces/codecs_interface.BlockCodec.html)
    <any, any\>\>
    

### `Optional` loadHasher[](#loadHasher)

*   loadHasher(code): [Await](../types/helia.Await.html)
    <[MultihashHasher](https://multiformats.github.io/js-multiformats/interfaces/hashes_interface.MultihashHasher.html)
    <number\>\>[](#loadHasher.loadHasher-1)
    
*   An optional function that can load a MultihashHasher on demand. May return a promise.
    
    #### Parameters
    
    *   code: number
    
    #### Returns [Await](../types/helia.Await.html)
    <[MultihashHasher](https://multiformats.github.io/js-multiformats/interfaces/hashes_interface.MultihashHasher.html)
    <number\>\>
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[blockBrokers](#blockBrokers)
[blockstore](#blockstore)
[codecs](#codecs)
[components](#components)
[datastore](#datastore)
[dns](#dns)
[hashers](#hashers)
[holdGcLock](#holdGcLock)
[logger](#logger)
[metrics](#metrics)
[providerLookupConcurrency](#providerLookupConcurrency)
[routers](#routers)
[loadCodec](#loadCodec)
[loadHasher](#loadHasher)

---

# AwaitIterable | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-store](../modules/interface_store.html)
    
*   [AwaitIterable](interface_store.AwaitIterable.html)
    

Type alias AwaitIterable<T>
===========================

AwaitIterable<[T](interface_store.AwaitIterable.html#T)
\>: [Iterable](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)
<[T](interface_store.AwaitIterable.html#T)
\> | AsyncIterable<[T](interface_store.AwaitIterable.html#T)
\>

An iterable or async iterable of values

#### Type Parameters

*   T

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# Store | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-store](../modules/interface_store.html)
    
*   [Store](interface_store.Store.html)
    

Interface Store<Key, Value, Pair, HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension>
======================================================================================================================================================================================================

interface Store<[Key](interface_store.Store.html#Key)
, [Value](interface_store.Store.html#Value)
, [Pair](interface_store.Store.html#Pair)
, [HasOptionsExtension](interface_store.Store.html#HasOptionsExtension)
, [PutOptionsExtension](interface_store.Store.html#PutOptionsExtension)
, [PutManyOptionsExtension](interface_store.Store.html#PutManyOptionsExtension)
, [GetOptionsExtension](interface_store.Store.html#GetOptionsExtension)
, [GetManyOptionsExtension](interface_store.Store.html#GetManyOptionsExtension)
, [DeleteOptionsExtension](interface_store.Store.html#DeleteOptionsExtension)
, [DeleteManyOptionsExtension](interface_store.Store.html#DeleteManyOptionsExtension)
\> {  
    [delete](interface_store.Store.html#delete.delete-1)
(key, options?): [Await](../types/interface_store.Await.html)
<void\>;  
    [deleteMany](interface_store.Store.html#deleteMany.deleteMany-1)
(source, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
<[Key](interface_store.Store.html#Key)
\>;  
    [get](interface_store.Store.html#get.get-1)
(key, options?): [Await](../types/interface_store.Await.html)
<[Value](interface_store.Store.html#Value)
\>;  
    [getMany](interface_store.Store.html#getMany.getMany-1)
(source, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
<[Pair](interface_store.Store.html#Pair)
\>;  
    [has](interface_store.Store.html#has.has-1)
(key, options?): [Await](../types/interface_store.Await.html)
<boolean\>;  
    [put](interface_store.Store.html#put.put-1)
(key, val, options?): [Await](../types/interface_store.Await.html)
<[Key](interface_store.Store.html#Key)
\>;  
    [putMany](interface_store.Store.html#putMany.putMany-1)
(source, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
<[Key](interface_store.Store.html#Key)
\>;  
}

#### Type Parameters

*   Key
*   Value
*   Pair
*   HasOptionsExtension = {}
*   PutOptionsExtension = {}
*   PutManyOptionsExtension = {}
*   GetOptionsExtension = {}
*   GetManyOptionsExtension = {}
*   DeleteOptionsExtension = {}
*   DeleteManyOptionsExtension = {}

#### Hierarchy

*   Store
    

##### Index

### Methods

[delete](interface_store.Store.html#delete)
 [deleteMany](interface_store.Store.html#deleteMany)
 [get](interface_store.Store.html#get)
 [getMany](interface_store.Store.html#getMany)
 [has](interface_store.Store.html#has)
 [put](interface_store.Store.html#put)
 [putMany](interface_store.Store.html#putMany)

Methods
-------

### delete[](#delete)

*   delete(key, options?): [Await](../types/interface_store.Await.html)
    <void\>[](#delete.delete-1)
    
*   Remove the record for the passed key
    
    #### Parameters
    
    *   key: [Key](interface_store.Store.html#Key)
        
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [DeleteOptionsExtension](interface_store.Store.html#DeleteOptionsExtension)
        
    
    #### Returns [Await](../types/interface_store.Await.html)
    <void\>
    
    #### Example
    
        await store.delete(new Key('awesome'))console.log('deleted awesome content :(')
        
    

### deleteMany[](#deleteMany)

*   deleteMany(source, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Key](interface_store.Store.html#Key)
    \>[](#deleteMany.deleteMany-1)
    
*   Remove values for the passed keys
    
    #### Parameters
    
    *   source: [AwaitIterable](../types/interface_store.AwaitIterable.html)
        <[Key](interface_store.Store.html#Key)
        \>
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [DeleteManyOptionsExtension](interface_store.Store.html#DeleteManyOptionsExtension)
        
    
    #### Returns [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Key](interface_store.Store.html#Key)
    \>
    
    #### Example
    
        const source = [new Key('awesome')]for await (const key of store.deleteMany(source)) {  console.log(`deleted content with key ${key}`)}
        
    

### get[](#get)

*   get(key, options?): [Await](../types/interface_store.Await.html)
    <[Value](interface_store.Store.html#Value)
    \>[](#get.get-1)
    
*   Retrieve the value stored under the given key
    
    #### Parameters
    
    *   key: [Key](interface_store.Store.html#Key)
        
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [GetOptionsExtension](interface_store.Store.html#GetOptionsExtension)
        
    
    #### Returns [Await](../types/interface_store.Await.html)
    <[Value](interface_store.Store.html#Value)
    \>
    
    #### Example
    
        const value = await store.get(new Key('awesome'))console.log('got content: %s', value.toString('utf8'))// => got content: datastore
        
    

### getMany[](#getMany)

*   getMany(source, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Pair](interface_store.Store.html#Pair)
    \>[](#getMany.getMany-1)
    
*   Retrieve values for the passed keys
    
    #### Parameters
    
    *   source: [AwaitIterable](../types/interface_store.AwaitIterable.html)
        <[Key](interface_store.Store.html#Key)
        \>
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [GetManyOptionsExtension](interface_store.Store.html#GetManyOptionsExtension)
        
    
    #### Returns [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Pair](interface_store.Store.html#Pair)
    \>
    
    #### Example
    
        for await (const { key, value } of store.getMany([new Key('awesome')])) {  console.log(`got "${key}" = "${new TextDecoder('utf8').decode(value)}"`')  // => got "/awesome" = "datastore"}
        
    

### has[](#has)

*   has(key, options?): [Await](../types/interface_store.Await.html)
    <boolean\>[](#has.has-1)
    
*   Check for the existence of a value for the passed key
    
    #### Parameters
    
    *   key: [Key](interface_store.Store.html#Key)
        
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [HasOptionsExtension](interface_store.Store.html#HasOptionsExtension)
        
    
    #### Returns [Await](../types/interface_store.Await.html)
    <boolean\>
    
    #### Example
    
        const exists = await store.has(new Key('awesome'))if (exists) { console.log('it is there')} else { console.log('it is not there')}
        
    

### put[](#put)

*   put(key, val, options?): [Await](../types/interface_store.Await.html)
    <[Key](interface_store.Store.html#Key)
    \>[](#put.put-1)
    
*   Store the passed value under the passed key
    
    #### Parameters
    
    *   key: [Key](interface_store.Store.html#Key)
        
    *   val: [Value](interface_store.Store.html#Value)
        
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [PutOptionsExtension](interface_store.Store.html#PutOptionsExtension)
        
    
    #### Returns [Await](../types/interface_store.Await.html)
    <[Key](interface_store.Store.html#Key)
    \>
    
    #### Example
    
        await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
        
    

### putMany[](#putMany)

*   putMany(source, options?): [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Key](interface_store.Store.html#Key)
    \>[](#putMany.putMany-1)
    
*   Store the given key/value pairs
    
    #### Parameters
    
    *   source: [AwaitIterable](../types/interface_store.AwaitIterable.html)
        <[Pair](interface_store.Store.html#Pair)
        \>
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [PutManyOptionsExtension](interface_store.Store.html#PutManyOptionsExtension)
        
    
    #### Returns [AwaitIterable](../types/interface_store.AwaitIterable.html)
    <[Key](interface_store.Store.html#Key)
    \>
    
    #### Example
    
        const source = [{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }]for await (const { key, value } of store.putMany(source)) {  console.info(`put content for key ${key}`)}
        
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[delete](#delete)
[deleteMany](#deleteMany)
[get](#get)
[getMany](#getMany)
[has](#has)
[put](#put)
[putMany](#putMany)

---

# interface-datastore | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-datastore](interface_datastore.html)
    

Module interface-datastore
==========================

[interface-datastore](#md:interface-datastore)

===============================================

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
 [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 [![codecov](https://img.shields.io/codecov/c/github/ipfs/js-stores.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-stores)
 [![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-stores/js-test-and-release.yml?branch=main&style=flat-square)](https://github.com/ipfs/js-stores/actions/workflows/js-test-and-release.yml?query=branch%3Amain)

> datastore interface

[About](#md:about)

===================

A Datastore is a key/value database that lets store/retrieve binary blobs using namespaced Keys.

It is used by IPFS to store/retrieve arbitrary metadata needed to run the node - DHT provider records, signed peer records, etc.

[Backed Implementations](#md:backed-implementations)

-----------------------------------------------------

*   File System: [`datastore-fs`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-fs)
    
*   IndexedDB: [`datastore-idb`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-idb)
    
*   level: [`datastore-level`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-level)
     (supports any levelup compatible backend)
*   Memory: [`datastore-core/memory`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/memory.ts)
    
*   S3: [`datastore-s3`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-s3)
    

[Wrapper Implementations](#md:wrapper-implementations)

-------------------------------------------------------

*   Keytransform: [`datstore-core/src/keytransform`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/keytransform.ts)
    
*   Mount: [`datastore-core/src/mount`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/mount.ts)
    
*   Namespace: [`datastore-core/src/namespace`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/namespace.ts)
    
*   Sharding: [`datastore-core/src/sharding`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/sharding.ts)
    
*   Tiered: [`datstore-core/src/tiered`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/tiered.ts)
    

If you want the same functionality as [go-ds-flatfs](https://github.com/ipfs/go-ds-flatfs)
, use sharding with fs.

[Example](#md:example)

-----------------------

    import FsStore from 'datastore-fs'import { ShardingDataStore, shard } from 'datastore-core'const fs = new FsStore('path/to/store')// flatfs now works like go-flatfsconst flatfs = await ShardingStore.createOrOpen(fs, new shard.NextToLast(2))
    

### [Test suite](#md:test-suite)

Available via the [`interface-datastore-tests`](https://npmjs.com/package/interface-datastore-tests)
 module

    import { interfaceDatastoreTests } from 'interface-datastore-tests'describe('mystore', () => {  interfaceDatastoreTests({    async setup () {      return instanceOfMyStore    },    async teardown () {      // cleanup resources    }  })})
    

### [Aborting requests](#md:aborting-requests)

Most API methods accept an \[AbortSignal\]\[\] as part of an options object. Implementations may listen for an `abort` event emitted by this object, or test the `signal.aborted` property. When received implementations should tear down any long-lived requests or resources created.

### [Concurrency](#md:concurrency)

The streaming `(put|get|delete)Many` methods are intended to be used with modules such as [it-parallel-batch](https://www.npmjs.com/package/it-parallel-batch)
 to allow calling code to control levels of parallelisation. The batching method ensures results are returned in the correct order, but interface implementations should be thread safe.

    import batch from 'it-parallel-batch'const source = [{  key: ..,  value: ..}]// put values into the datastore concurrently, max 10 at a timefor await (const { key, data } of batch(store.putMany(source), 10)) {  console.info(`Put ${key}`)}
    

### [Keys](#md:keys)

To allow a better abstraction on how to address values, there is a `Key` class which is used as identifier. It's easy to create a key from a `Uint8Array` or a `string`.

    const a = new Key('a')const b = new Key(new Uint8Array([0, 1, 2, 3]))
    

The key scheme is inspired by file systems and Google App Engine key model. Keys are meant to be unique across a system. They are typically hierarchical, incorporating more and more specific namespaces. Thus keys can be deemed 'children' or 'ancestors' of other keys:

*   `new Key('/Comedy')`
*   `new Key('/Comedy/MontyPython')`

Also, every namespace can be parameterized to embed relevant object information. For example, the Key `name` (most specific namespace) could include the object type:

*   `new Key('/Comedy/MontyPython/Actor:JohnCleese')`
*   `new Key('/Comedy/MontyPython/Sketch:CheeseShop')`
*   `new Key('/Comedy/MontyPython/Sketch:CheeseShop/Character:Mousebender')`

[Install](#md:install)

=======================

    $ npm i interface-datastore
    

[Browser `<script>` tag](#md:browser-ltscriptgt-tag)

-----------------------------------------------------

Loading this module through a script tag will make its exports available as `InterfaceDatastore` in the global namespace.

    <script src="https://unpkg.com/interface-datastore/dist/index.min.js"></script>
    

[API Docs](#md:api-docs)

=========================

*   [https://ipfs.github.io/js-stores/modules/interface\_datastore.html](https://ipfs.github.io/js-stores/modules/interface_datastore.html)
    

[License](#md:license)

=======================

Licensed under either of

*   Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/js-stores/blob/main/packages/interface-datastore/LICENSE-APACHE)
     / [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
    )
*   MIT ([LICENSE-MIT](https://github.com/ipfs/js-stores/blob/main/packages/interface-datastore/LICENSE-MIT)
     / [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)
    )

[Contribute](#md:contribute)

=============================

Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-stores/issues)
.

Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md)
 for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md)
.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

### Index

### Modules

[index](interface_datastore.index.html)
 [key](interface_datastore.key.html)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[interface-datastore](#md:interface-datastore)
[About](#md:about)

*   [Backed Implementations](#md:backed-implementations)
    
*   [Wrapper Implementations](#md:wrapper-implementations)
    
*   [Example](#md:example)
    
*   *   [Test suite](#md:test-suite)
        
    *   [Aborting requests](#md:aborting-requests)
        
    *   [Concurrency](#md:concurrency)
        
    *   [Keys](#md:keys)
        

[Install](#md:install)

*   [Browser <script> tag](#md:browser-ltscriptgt-tag)
    

[API Docs](#md:api-docs)
[License](#md:license)
[Contribute](#md:contribute)

---

# index | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-datastore](interface_datastore.html)
    
*   [index](interface_datastore.index.html)
    

Module index
============

A Datastore is a key/value database that lets store/retrieve binary blobs using namespaced Keys.

It is used by IPFS to store/retrieve arbitrary metadata needed to run the node - DHT provider records, signed peer records, etc.

[Backed Implementations](#md:backed-implementations)

-----------------------------------------------------

*   File System: [`datastore-fs`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-fs)
    
*   IndexedDB: [`datastore-idb`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-idb)
    
*   level: [`datastore-level`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-level)
     (supports any levelup compatible backend)
*   Memory: [`datastore-core/memory`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/memory.ts)
    
*   S3: [`datastore-s3`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-s3)
    

[Wrapper Implementations](#md:wrapper-implementations)

-------------------------------------------------------

*   Keytransform: [`datstore-core/src/keytransform`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/keytransform.ts)
    
*   Mount: [`datastore-core/src/mount`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/mount.ts)
    
*   Namespace: [`datastore-core/src/namespace`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/namespace.ts)
    
*   Sharding: [`datastore-core/src/sharding`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/sharding.ts)
    
*   Tiered: [`datstore-core/src/tiered`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/tiered.ts)
    

If you want the same functionality as [go-ds-flatfs](https://github.com/ipfs/go-ds-flatfs)
, use sharding with fs.

#### Example

    import FsStore from 'datastore-fs'import { ShardingDataStore, shard } from 'datastore-core'const fs = new FsStore('path/to/store')// flatfs now works like go-flatfsconst flatfs = await ShardingStore.createOrOpen(fs, new shard.NextToLast(2))
    

### [Test suite](#md:test-suite)

Available via the [`interface-datastore-tests`](https://npmjs.com/package/interface-datastore-tests)
 module

    import { interfaceDatastoreTests } from 'interface-datastore-tests'describe('mystore', () => {  interfaceDatastoreTests({    async setup () {      return instanceOfMyStore    },    async teardown () {      // cleanup resources    }  })})
    

### [Aborting requests](#md:aborting-requests)

Most API methods accept an \[AbortSignal\]\[\] as part of an options object. Implementations may listen for an `abort` event emitted by this object, or test the `signal.aborted` property. When received implementations should tear down any long-lived requests or resources created.

### [Concurrency](#md:concurrency)

The streaming `(put|get|delete)Many` methods are intended to be used with modules such as [it-parallel-batch](https://www.npmjs.com/package/it-parallel-batch)
 to allow calling code to control levels of parallelisation. The batching method ensures results are returned in the correct order, but interface implementations should be thread safe.

    import batch from 'it-parallel-batch'const source = [{  key: ..,  value: ..}]// put values into the datastore concurrently, max 10 at a timefor await (const { key, data } of batch(store.putMany(source), 10)) {  console.info(`Put ${key}`)}
    

### [Keys](#md:keys)

To allow a better abstraction on how to address values, there is a `Key` class which is used as identifier. It's easy to create a key from a `Uint8Array` or a `string`.

    const a = new Key('a')const b = new Key(new Uint8Array([0, 1, 2, 3]))
    

The key scheme is inspired by file systems and Google App Engine key model. Keys are meant to be unique across a system. They are typically hierarchical, incorporating more and more specific namespaces. Thus keys can be deemed 'children' or 'ancestors' of other keys:

*   `new Key('/Comedy')`
*   `new Key('/Comedy/MontyPython')`

Also, every namespace can be parameterized to embed relevant object information. For example, the Key `name` (most specific namespace) could include the object type:

*   `new Key('/Comedy/MontyPython/Actor:JohnCleese')`
*   `new Key('/Comedy/MontyPython/Sketch:CheeseShop')`
*   `new Key('/Comedy/MontyPython/Sketch:CheeseShop/Character:Mousebender')`

##### Index

### References

[Key](interface_datastore.index.html#Key)

### Interfaces

[Batch](../interfaces/interface_datastore.index.Batch.html)
 [Datastore](../interfaces/interface_datastore.index.Datastore.html)
 [KeyQuery](../interfaces/interface_datastore.index.KeyQuery.html)
 [KeyQueryFilter](../interfaces/interface_datastore.index.KeyQueryFilter.html)
 [KeyQueryOrder](../interfaces/interface_datastore.index.KeyQueryOrder.html)
 [Pair](../interfaces/interface_datastore.index.Pair.html)
 [Query](../interfaces/interface_datastore.index.Query.html)
 [QueryFilter](../interfaces/interface_datastore.index.QueryFilter.html)
 [QueryOrder](../interfaces/interface_datastore.index.QueryOrder.html)

References
----------

### Key[](#Key)

Re-exports [Key](../classes/interface_datastore.key.Key.html)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

*   *   [Backed Implementations](#md:backed-implementations)
        
    *   [Wrapper Implementations](#md:wrapper-implementations)
        
    *   *   [Test suite](#md:test-suite)
            
        *   [Aborting requests](#md:aborting-requests)
            
        *   [Concurrency](#md:concurrency)
            
        *   [Keys](#md:keys)
            

[Key](#Key)

---

# Batch | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-datastore](../modules/interface_datastore.html)
    
*   [index](../modules/interface_datastore.index.html)
    
*   [Batch](interface_datastore.index.Batch.html)
    

Interface Batch<BatchOptionsExtension>
======================================

interface Batch<[BatchOptionsExtension](interface_datastore.index.Batch.html#BatchOptionsExtension)
\> {  
    [commit](interface_datastore.index.Batch.html#commit.commit-1)
(options?): [Await](../types/interface_store.Await.html)
<void\>;  
    [delete](interface_datastore.index.Batch.html#delete.delete-1)
(key): void;  
    [put](interface_datastore.index.Batch.html#put.put-1)
(key, value): void;  
}

#### Type Parameters

*   BatchOptionsExtension = {}

##### Index

### Methods

[commit](interface_datastore.index.Batch.html#commit)
 [delete](interface_datastore.index.Batch.html#delete)
 [put](interface_datastore.index.Batch.html#put)

Methods
-------

### commit[](#commit)

*   commit(options?): [Await](../types/interface_store.Await.html)
    <void\>[](#commit.commit-1)
    
*   #### Parameters
    
    *   `Optional` options: [AbortOptions](interface_store.AbortOptions.html)
         & [BatchOptionsExtension](interface_datastore.index.Batch.html#BatchOptionsExtension)
        
    
    #### Returns [Await](../types/interface_store.Await.html)
    <void\>
    

### delete[](#delete)

*   delete(key): void[](#delete.delete-1)
    
*   #### Parameters
    
    *   key: [Key](../classes/interface_datastore.key.Key.html)
        
    
    #### Returns void
    

### put[](#put)

*   put(key, value): void[](#put.put-1)
    
*   #### Parameters
    
    *   key: [Key](../classes/interface_datastore.key.Key.html)
        
    *   value: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
        
    
    #### Returns void
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[commit](#commit)
[delete](#delete)
[put](#put)

---

# interface-store | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-store](interface_store.html)
    

Module interface-store
======================

An abstraction of the Datastore/Blockstore codebases.

[interface-store](#md:interface-store)

=======================================

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
 [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 [![codecov](https://img.shields.io/codecov/c/github/ipfs/js-stores.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-stores)
 [![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-stores/js-test-and-release.yml?branch=main&style=flat-square)](https://github.com/ipfs/js-stores/actions/workflows/js-test-and-release.yml?query=branch%3Amain)

> A generic interface for storing and retrieving data

[About](#md:about)

===================

An abstraction of the Datastore/Blockstore codebases.

[Install](#md:install)

=======================

    $ npm i interface-store
    

[API Docs](#md:api-docs)

=========================

*   [https://ipfs.github.io/js-stores/modules/interface\_store.html](https://ipfs.github.io/js-stores/modules/interface_store.html)
    

[License](#md:license)

=======================

Licensed under either of

*   Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/js-stores/blob/main/packages/interface-store/LICENSE-APACHE)
     / [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
    )
*   MIT ([LICENSE-MIT](https://github.com/ipfs/js-stores/blob/main/packages/interface-store/LICENSE-MIT)
     / [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)
    )

[Contribute](#md:contribute)

=============================

Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-stores/issues)
.

Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md)
 for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md)
.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

### Index

### Classes

[AbortError](../classes/interface_store.AbortError.html)
 [CloseFailedError](../classes/interface_store.CloseFailedError.html)
 [DeleteFailedError](../classes/interface_store.DeleteFailedError.html)
 [GetFailedError](../classes/interface_store.GetFailedError.html)
 [HasFailedError](../classes/interface_store.HasFailedError.html)
 [NotFoundError](../classes/interface_store.NotFoundError.html)
 [OpenFailedError](../classes/interface_store.OpenFailedError.html)
 [PutFailedError](../classes/interface_store.PutFailedError.html)

### Interfaces

[AbortOptions](../interfaces/interface_store.AbortOptions.html)
 [Store](../interfaces/interface_store.Store.html)

### Type Aliases

[Await](../types/interface_store.Await.html)
 [AwaitIterable](../types/interface_store.AwaitIterable.html)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[interface-store](#md:interface-store)
[About](#md:about)
[Install](#md:install)
[API Docs](#md:api-docs)
[License](#md:license)
[Contribute](#md:contribute)

---

# KeyQuery | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-datastore](../modules/interface_datastore.html)
    
*   [index](../modules/interface_datastore.index.html)
    
*   [KeyQuery](interface_datastore.index.KeyQuery.html)
    

Interface KeyQuery
==================

interface KeyQuery {  
    [filters](interface_datastore.index.KeyQuery.html#filters)
?: [KeyQueryFilter](interface_datastore.index.KeyQueryFilter.html)
\[\];  
    [limit](interface_datastore.index.KeyQuery.html#limit)
?: number;  
    [offset](interface_datastore.index.KeyQuery.html#offset)
?: number;  
    [orders](interface_datastore.index.KeyQuery.html#orders)
?: [KeyQueryOrder](interface_datastore.index.KeyQueryOrder.html)
\[\];  
    [prefix](interface_datastore.index.KeyQuery.html#prefix)
?: string;  
}

##### Index

### Properties

[filters?](interface_datastore.index.KeyQuery.html#filters)
 [limit?](interface_datastore.index.KeyQuery.html#limit)
 [offset?](interface_datastore.index.KeyQuery.html#offset)
 [orders?](interface_datastore.index.KeyQuery.html#orders)
 [prefix?](interface_datastore.index.KeyQuery.html#prefix)

Properties
----------

### `Optional` filters[](#filters)

filters?: [KeyQueryFilter](interface_datastore.index.KeyQueryFilter.html)
\[\]

### `Optional` limit[](#limit)

limit?: number

### `Optional` offset[](#offset)

offset?: number

### `Optional` orders[](#orders)

orders?: [KeyQueryOrder](interface_datastore.index.KeyQueryOrder.html)
\[\]

### `Optional` prefix[](#prefix)

prefix?: string

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[filters](#filters)
[limit](#limit)
[offset](#offset)
[orders](#orders)
[prefix](#prefix)

---

# IPFS Stores

IPFS Stores
-----------

[stores](#md:stores)

=====================

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
 [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 [![codecov](https://img.shields.io/codecov/c/github/ipfs/js-stores.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-stores)
 [![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-stores/js-test-and-release.yml?branch=main&style=flat-square)](https://github.com/ipfs/js-stores/actions/workflows/js-test-and-release.yml?query=branch%3Amain)

> Blockstores and datastores used by IP-JS internals

[Packages](#md:packages)

=========================

*   [`packages/blockstore-core`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-core)
     Contains various implementations of the API contract described in interface-blockstore
*   [`packages/blockstore-fs`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-fs)
     Blockstore implementation with file system backend
*   [`packages/blockstore-idb`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-idb)
     Blockstore implementation with IndexedDB backend
*   [`packages/blockstore-level`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-level)
     Blockstore implementation with level(up|down) backend
*   [`packages/blockstore-s3`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-s3)
     IPFS blockstore implementation backed by s3
*   [`packages/datastore-core`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-core)
     Wrapper implementation for interface-datastore
*   [`packages/datastore-fs`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-fs)
     Datastore implementation with file system backend
*   [`packages/datastore-idb`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-idb)
     Datastore implementation with IndexedDB backend.
*   [`packages/datastore-level`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-level)
     Datastore implementation with level(up|down) backend
*   [`packages/datastore-s3`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-s3)
     IPFS datastore implementation backed by s3
*   [`packages/interface-blockstore`](https://github.com/ipfs/js-stores/tree/main/packages/interface-blockstore)
     An interface for storing and retrieving blocks
*   [`packages/interface-blockstore-tests`](https://github.com/ipfs/js-stores/tree/main/packages/interface-blockstore-tests)
     Compliance tests for the blockstore interface
*   [`packages/interface-datastore`](https://github.com/ipfs/js-stores/tree/main/packages/interface-datastore)
     datastore interface
*   [`packages/interface-datastore-tests`](https://github.com/ipfs/js-stores/tree/main/packages/interface-datastore-tests)
     Compliance tests for the datastore interface
*   [`packages/interface-store`](https://github.com/ipfs/js-stores/tree/main/packages/interface-store)
     A generic interface for storing and retrieving data

[API Docs](#md:api-docs)

=========================

*   [https://ipfs.github.io/js-stores](https://ipfs.github.io/js-stores)
    

[License](#md:license)

=======================

Licensed under either of

*   Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/js-stores/blob/main/LICENSE-APACHE)
     / [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
    )
*   MIT ([LICENSE-MIT](https://github.com/ipfs/js-stores/blob/main/LICENSE-MIT)
     / [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)
    )

[Contribute](#md:contribute)

=============================

Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-stores/issues)
.

Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md)
 for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md)
.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[stores](#md:stores)
[Packages](#md:packages)
[API Docs](#md:api-docs)
[License](#md:license)
[Contribute](#md:contribute)

---

# Key | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-datastore](../modules/interface_datastore.html)
    
*   [key](../modules/interface_datastore.key.html)
    
*   [Key](interface_datastore.key.Key.html)
    

Class Key
=========

A Key represents the unique identifier of an object. Our Key scheme is inspired by file systems and Google App Engine key model. Keys are meant to be unique across a system. Keys are hierarchical, incorporating more and more specific namespaces. Thus keys can be deemed 'children' or 'ancestors' of other keys:

*   `new Key('/Comedy')`
*   `new Key('/Comedy/MontyPython')` Also, every namespace can be parametrized to embed relevant object information. For example, the Key `name` (most specific namespace) could include the object type:
*   `new Key('/Comedy/MontyPython/Actor:JohnCleese')`
*   `new Key('/Comedy/MontyPython/Sketch:CheeseShop')`
*   `new Key('/Comedy/MontyPython/Sketch:CheeseShop/Character:Mousebender')`

##### Index

### Constructors

[constructor](interface_datastore.key.Key.html#constructor)

### Properties

[\_buf](interface_datastore.key.Key.html#_buf)

### Accessors

[\[toStringTag\]](interface_datastore.key.Key.html#_toStringTag_)

### Methods

[baseNamespace](interface_datastore.key.Key.html#baseNamespace)
 [child](interface_datastore.key.Key.html#child)
 [clean](interface_datastore.key.Key.html#clean)
 [concat](interface_datastore.key.Key.html#concat)
 [instance](interface_datastore.key.Key.html#instance)
 [isAncestorOf](interface_datastore.key.Key.html#isAncestorOf)
 [isDecendantOf](interface_datastore.key.Key.html#isDecendantOf)
 [isTopLevel](interface_datastore.key.Key.html#isTopLevel)
 [less](interface_datastore.key.Key.html#less)
 [list](interface_datastore.key.Key.html#list)
 [name](interface_datastore.key.Key.html#name)
 [namespaces](interface_datastore.key.Key.html#namespaces)
 [parent](interface_datastore.key.Key.html#parent)
 [path](interface_datastore.key.Key.html#path)
 [reverse](interface_datastore.key.Key.html#reverse)
 [toString](interface_datastore.key.Key.html#toString)
 [type](interface_datastore.key.Key.html#type)
 [uint8Array](interface_datastore.key.Key.html#uint8Array)
 [asKey](interface_datastore.key.Key.html#asKey)
 [random](interface_datastore.key.Key.html#random)
 [withNamespaces](interface_datastore.key.Key.html#withNamespaces)

Constructors
------------

### constructor[](#constructor)

*   new Key(s, clean?): [Key](interface_datastore.key.Key.html)
    [](#constructor.new_Key)
    
*   #### Parameters
    
    *   s: string | [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
        
    *   `Optional` clean: boolean
    
    #### Returns [Key](interface_datastore.key.Key.html)
    

Properties
----------

### `Private` \_buf[](#_buf)

\_buf: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)

Accessors
---------

### \[toStringTag\][](#_toStringTag_)

*   get \[toStringTag\](): string
*   Return string representation of the key
    
    #### Returns string
    

Methods
-------

### baseNamespace[](#baseNamespace)

*   baseNamespace(): string[](#baseNamespace.baseNamespace-1)
    
*   Returns the "base" namespace of this key.
    
    #### Returns string
    
    #### Example
    
        new Key('/Comedy/MontyPython/Actor:JohnCleese').baseNamespace()// => 'Actor:JohnCleese'
        
    

### child[](#child)

*   child(key): [Key](interface_datastore.key.Key.html)
    [](#child.child-1)
    
*   Returns the `child` Key of this Key.
    
    #### Parameters
    
    *   key: [Key](interface_datastore.key.Key.html)
        
        The child Key to add
        
    
    #### Returns [Key](interface_datastore.key.Key.html)
    
    #### Example
    
        new Key('/Comedy/MontyPython').child(new Key('Actor:JohnCleese'))// => Key('/Comedy/MontyPython/Actor:JohnCleese')
        
    

### clean[](#clean)

*   clean(): void[](#clean.clean-1)
    
*   Cleanup the current key
    
    #### Returns void
    

### concat[](#concat)

*   concat(...keys): [Key](interface_datastore.key.Key.html)
    [](#concat.concat-1)
    
*   Concats one or more Keys into one new Key.
    
    #### Parameters
    
    *   `Rest` ...keys: [Key](interface_datastore.key.Key.html)
        \[\]
        
        The array of keys to concatenate
        
    
    #### Returns [Key](interface_datastore.key.Key.html)
    

### instance[](#instance)

*   instance(s): [Key](interface_datastore.key.Key.html)
    [](#instance.instance-1)
    
*   Returns an "instance" of this type key (appends value to namespace).
    
    #### Parameters
    
    *   s: string
        
        The string to append.
        
    
    #### Returns [Key](interface_datastore.key.Key.html)
    
    #### Example
    
        new Key('/Comedy/MontyPython/Actor').instance('JohnClesse')// => Key('/Comedy/MontyPython/Actor:JohnCleese')
        
    

### isAncestorOf[](#isAncestorOf)

*   isAncestorOf(other): boolean[](#isAncestorOf.isAncestorOf-1)
    
*   Returns whether this key is a prefix of `other`
    
    #### Parameters
    
    *   other: [Key](interface_datastore.key.Key.html)
        
        The other key to test against
        
    
    #### Returns boolean
    
    #### Example
    
        new Key('/Comedy').isAncestorOf('/Comedy/MontyPython')// => true
        
    

### isDecendantOf[](#isDecendantOf)

*   isDecendantOf(other): boolean[](#isDecendantOf.isDecendantOf-1)
    
*   Returns whether this key is a contains another as prefix.
    
    #### Parameters
    
    *   other: [Key](interface_datastore.key.Key.html)
        
        The other Key to test against
        
    
    #### Returns boolean
    
    #### Example
    
        new Key('/Comedy/MontyPython').isDecendantOf('/Comedy')// => true
        
    

### isTopLevel[](#isTopLevel)

*   isTopLevel(): boolean[](#isTopLevel.isTopLevel-1)
    
*   Checks if this key has only one namespace.
    
    #### Returns boolean
    

### less[](#less)

*   less(key): boolean[](#less.less-1)
    
*   Check if the given key is sorted lower than ourself.
    
    #### Parameters
    
    *   key: [Key](interface_datastore.key.Key.html)
        
        The other Key to check against
        
    
    #### Returns boolean
    

### list[](#list)

*   list(): string\[\][](#list.list-1)
    
*   Returns the `list` representation of this key.
    
    #### Returns string\[\]
    
    #### Example
    
        new Key('/Comedy/MontyPython/Actor:JohnCleese').list()// => ['Comedy', 'MontyPythong', 'Actor:JohnCleese']
        
    

### name[](#name)

*   name(): string[](#name.name-1)
    
*   Returns the "name" of this key (field of last namespace).
    
    #### Returns string
    
    #### Example
    
        new Key('/Comedy/MontyPython/Actor:JohnCleese').name()// => 'JohnCleese'
        
    

### namespaces[](#namespaces)

*   namespaces(): string\[\][](#namespaces.namespaces-1)
    
*   Returns the `namespaces` making up this Key.
    
    #### Returns string\[\]
    

### parent[](#parent)

*   parent(): [Key](interface_datastore.key.Key.html)
    [](#parent.parent-1)
    
*   Returns the `parent` Key of this Key.
    
    #### Returns [Key](interface_datastore.key.Key.html)
    
    #### Example
    
        new Key("/Comedy/MontyPython/Actor:JohnCleese").parent()// => Key("/Comedy/MontyPython")
        
    

### path[](#path)

*   path(): [Key](interface_datastore.key.Key.html)
    [](#path.path-1)
    
*   Returns the "path" of this key (parent + type).
    
    #### Returns [Key](interface_datastore.key.Key.html)
    
    #### Example
    
        new Key('/Comedy/MontyPython/Actor:JohnCleese').path()// => Key('/Comedy/MontyPython/Actor')
        
    

### reverse[](#reverse)

*   reverse(): [Key](interface_datastore.key.Key.html)
    [](#reverse.reverse-1)
    
*   Returns the key with all parts in reversed order.
    
    #### Returns [Key](interface_datastore.key.Key.html)
    
    #### Example
    
        new Key('/Comedy/MontyPython/Actor:JohnCleese').reverse()// => Key('/Actor:JohnCleese/MontyPython/Comedy')
        
    

### toString[](#toString)

*   toString(encoding?): string[](#toString.toString-1)
    
*   Convert to the string representation
    
    #### Parameters
    
    *   `Optional` encoding: [SupportedEncodings](https://achingbrain.github.io/uint8arrays/types/index.SupportedEncodings.html)
         = 'utf8'
        
        The encoding to use.
        
    
    #### Returns string
    

### type[](#type)

*   type(): string[](#type.type-1)
    
*   Returns the "type" of this key (value of last namespace).
    
    #### Returns string
    
    #### Example
    
        new Key('/Comedy/MontyPython/Actor:JohnCleese').type()// => 'Actor'
        
    

### uint8Array[](#uint8Array)

*   uint8Array(): [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    [](#uint8Array.uint8Array-1)
    
*   Return the Uint8Array representation of the key
    
    #### Returns [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    

### `Static` asKey[](#asKey)

*   asKey(other): null | [Key](interface_datastore.key.Key.html)
    [](#asKey.asKey-1)
    
*   #### Parameters
    
    *   other: any
    
    #### Returns null | [Key](interface_datastore.key.Key.html)
    

### `Static` random[](#random)

*   random(): [Key](interface_datastore.key.Key.html)
    [](#random.random-1)
    
*   Returns a randomly (uuid) generated key.
    
    #### Returns [Key](interface_datastore.key.Key.html)
    
    #### Example
    
        Key.random()// => Key('/344502982398')
        
    

### `Static` withNamespaces[](#withNamespaces)

*   withNamespaces(list): [Key](interface_datastore.key.Key.html)
    [](#withNamespaces.withNamespaces-1)
    
*   Constructs a key out of a namespace array.
    
    #### Parameters
    
    *   list: string\[\]
        
        The array of namespaces
        
    
    #### Returns [Key](interface_datastore.key.Key.html)
    
    #### Example
    
        Key.withNamespaces(['one', 'two'])// => Key('/one/two')
        
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[constructor](#constructor)
[\_buf](#_buf)
[\[toStringTag\]](#_toStringTag_)
[baseNamespace](#baseNamespace)
[child](#child)
[clean](#clean)
[concat](#concat)
[instance](#instance)
[isAncestorOf](#isAncestorOf)
[isDecendantOf](#isDecendantOf)
[isTopLevel](#isTopLevel)
[less](#less)
[list](#list)
[name](#name)
[namespaces](#namespaces)
[parent](#parent)
[path](#path)
[reverse](#reverse)
[toString](#toString)
[type](#type)
[uint8Array](#uint8Array)
[asKey](#asKey)
[random](#random)
[withNamespaces](#withNamespaces)

---

# @helia/utils | Helia

*   [Helia](../index.html)
    
*   [@helia/utils](_helia_utils.html)
    

Module @helia/utils
===================

Exports a `Helia` class that implements the Helia API.

In general you should use the `helia` or `@helia/http` modules instead which pre-configure Helia for certain use-cases (p2p or pure-HTTP).

#### Example

    import { Helia } from '@helia/utils'import type { HeliaInit } from '@helia/utils'const node = new Helia({  // ...options} as HeliaInit)
    

[![Helia logo](https://raw.githubusercontent.com/ipfs/helia/main/assets/helia.png)](https://github.com/ipfs/helia "Helia")

[@helia/utils](#md:heliautils)

===============================

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
 [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 [![codecov](https://img.shields.io/codecov/c/github/ipfs/helia.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia)
 [![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia/main.yml?branch=main&style=flat-square)](https://github.com/ipfs/helia/actions/workflows/main.yml?query=branch%3Amain)

> Shared code that implements the Helia API

[About](#md:about)

===================

Exports a `Helia` class that implements the Helia API.

In general you should use the `helia` or `@helia/http` modules instead which pre-configure Helia for certain use-cases (p2p or pure-HTTP).

[Example](#md:example)

-----------------------

    import { Helia } from '@helia/utils'import type { HeliaInit } from '@helia/utils'const node = new Helia({  // ...options} as HeliaInit)
    

[Install](#md:install)

=======================

    $ npm i @helia/utils
    

[Browser `<script>` tag](#md:browser-ltscriptgt-tag)

-----------------------------------------------------

Loading this module through a script tag will make its exports available as `HeliaUtils` in the global namespace.

    <script src="https://unpkg.com/@helia/utils/dist/index.min.js"></script>
    

[API Docs](#md:api-docs)

=========================

*   [https://ipfs.github.io/helia/modules/\_helia\_utils.html](https://ipfs.github.io/helia/modules/_helia_utils.html)
    

[License](#md:license)

=======================

Licensed under either of

*   Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/helia/blob/main/packages/utils/LICENSE-APACHE)
     / [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
    )
*   MIT ([LICENSE-MIT](https://github.com/ipfs/helia/blob/main/packages/utils/LICENSE-MIT)
     / [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)
    )

[Contribute](#md:contribute)

=============================

Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia/issues)
.

Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md)
 for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md)
.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

### Index

### Classes

[AbstractSession](../classes/_helia_utils.AbstractSession.html)
 [BlockStorage](../classes/_helia_utils.BlockStorage.html)
 [Helia](../classes/_helia_utils.Helia.html)

### Interfaces

[AbstractCreateSessionOptions](../interfaces/_helia_utils.AbstractCreateSessionOptions.html)
 [AbstractSessionComponents](../interfaces/_helia_utils.AbstractSessionComponents.html)
 [BlockStorageInit](../interfaces/_helia_utils.BlockStorageInit.html)
 [BlockstoreSessionEvents](../interfaces/_helia_utils.BlockstoreSessionEvents.html)
 [HeliaInit](../interfaces/_helia_utils.HeliaInit.html)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[@helia/utils](#md:heliautils)
[About](#md:about)

*   [Example](#md:example)
    

[Install](#md:install)

*   [Browser <script> tag](#md:browser-ltscriptgt-tag)
    

[API Docs](#md:api-docs)
[License](#md:license)
[Contribute](#md:contribute)

---

# key | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-datastore](interface_datastore.html)
    
*   [key](interface_datastore.key.html)
    

Module key
==========

### Index

### Classes

[Key](../classes/interface_datastore.key.Key.html)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# KeyQueryFilter | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-datastore](../modules/interface_datastore.html)
    
*   [index](../modules/interface_datastore.index.html)
    
*   [KeyQueryFilter](interface_datastore.index.KeyQueryFilter.html)
    

Interface KeyQueryFilter
========================

interface KeyQueryFilter ((item) => boolean)

*   KeyQueryFilter(item): boolean[](#KeyQueryFilter)
    
*   #### Parameters
    
    *   item: [Key](../classes/interface_datastore.key.Key.html)
        
    
    #### Returns boolean
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# Pair | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-datastore](../modules/interface_datastore.html)
    
*   [index](../modules/interface_datastore.index.html)
    
*   [Pair](interface_datastore.index.Pair.html)
    

Interface Pair
==============

interface Pair {  
    [key](interface_datastore.index.Pair.html#key)
: [Key](../classes/interface_datastore.key.Key.html)
;  
    [value](interface_datastore.index.Pair.html#value)
: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
;  
}

##### Index

### Properties

[key](interface_datastore.index.Pair.html#key)
 [value](interface_datastore.index.Pair.html#value)

Properties
----------

### key[](#key)

key: [Key](../classes/interface_datastore.key.Key.html)

### value[](#value)

value: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[key](#key)
[value](#value)

---

# Query | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-datastore](../modules/interface_datastore.html)
    
*   [index](../modules/interface_datastore.index.html)
    
*   [Query](interface_datastore.index.Query.html)
    

Interface Query
===============

interface Query {  
    [filters](interface_datastore.index.Query.html#filters)
?: [QueryFilter](interface_datastore.index.QueryFilter.html)
\[\];  
    [limit](interface_datastore.index.Query.html#limit)
?: number;  
    [offset](interface_datastore.index.Query.html#offset)
?: number;  
    [orders](interface_datastore.index.Query.html#orders)
?: [QueryOrder](interface_datastore.index.QueryOrder.html)
\[\];  
    [prefix](interface_datastore.index.Query.html#prefix)
?: string;  
}

##### Index

### Properties

[filters?](interface_datastore.index.Query.html#filters)
 [limit?](interface_datastore.index.Query.html#limit)
 [offset?](interface_datastore.index.Query.html#offset)
 [orders?](interface_datastore.index.Query.html#orders)
 [prefix?](interface_datastore.index.Query.html#prefix)

Properties
----------

### `Optional` filters[](#filters)

filters?: [QueryFilter](interface_datastore.index.QueryFilter.html)
\[\]

### `Optional` limit[](#limit)

limit?: number

### `Optional` offset[](#offset)

offset?: number

### `Optional` orders[](#orders)

orders?: [QueryOrder](interface_datastore.index.QueryOrder.html)
\[\]

### `Optional` prefix[](#prefix)

prefix?: string

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[filters](#filters)
[limit](#limit)
[offset](#offset)
[orders](#orders)
[prefix](#prefix)

---

# KeyQueryOrder | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-datastore](../modules/interface_datastore.html)
    
*   [index](../modules/interface_datastore.index.html)
    
*   [KeyQueryOrder](interface_datastore.index.KeyQueryOrder.html)
    

Interface KeyQueryOrder
=======================

interface KeyQueryOrder ((a, b) => \-1 | 0 | 1)

*   KeyQueryOrder(a, b): \-1 | 0 | 1[](#KeyQueryOrder)
    
*   #### Parameters
    
    *   a: [Key](../classes/interface_datastore.key.Key.html)
        
    *   b: [Key](../classes/interface_datastore.key.Key.html)
        
    
    #### Returns \-1 | 0 | 1
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# QueryFilter | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-datastore](../modules/interface_datastore.html)
    
*   [index](../modules/interface_datastore.index.html)
    
*   [QueryFilter](interface_datastore.index.QueryFilter.html)
    

Interface QueryFilter
=====================

interface QueryFilter ((item) => boolean)

*   QueryFilter(item): boolean[](#QueryFilter)
    
*   #### Parameters
    
    *   item: [Pair](interface_datastore.index.Pair.html)
        
    
    #### Returns boolean
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# QueryOrder | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-datastore](../modules/interface_datastore.html)
    
*   [index](../modules/interface_datastore.index.html)
    
*   [QueryOrder](interface_datastore.index.QueryOrder.html)
    

Interface QueryOrder
====================

interface QueryOrder ((a, b) => \-1 | 0 | 1)

*   QueryOrder(a, b): \-1 | 0 | 1[](#QueryOrder)
    
*   #### Parameters
    
    *   a: [Pair](interface_datastore.index.Pair.html)
        
    *   b: [Pair](interface_datastore.index.Pair.html)
        
    
    #### Returns \-1 | 0 | 1
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

---

# AbortError | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-store](../modules/interface_store.html)
    
*   [AbortError](interface_store.AbortError.html)
    

Class AbortError
================

#### Hierarchy

*   [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
    *   AbortError

##### Index

### Constructors

[constructor](interface_store.AbortError.html#constructor)

### Properties

[cause?](interface_store.AbortError.html#cause)
 [code](interface_store.AbortError.html#code)
 [message](interface_store.AbortError.html#message)
 [name](interface_store.AbortError.html#name)
 [stack?](interface_store.AbortError.html#stack)
 [code](interface_store.AbortError.html#code-1)
 [name](interface_store.AbortError.html#name-1)
 [prepareStackTrace?](interface_store.AbortError.html#prepareStackTrace)
 [stackTraceLimit](interface_store.AbortError.html#stackTraceLimit)

### Methods

[captureStackTrace](interface_store.AbortError.html#captureStackTrace)

Constructors
------------

### constructor[](#constructor)

*   new AbortError(message?): [AbortError](interface_store.AbortError.html)
    [](#constructor.new_AbortError)
    
*   #### Parameters
    
    *   message: string = 'Aborted'
    
    #### Returns [AbortError](interface_store.AbortError.html)
    

Properties
----------

### `Optional` cause[](#cause)

cause?: unknown

### code[](#code)

code: string = AbortError.code

### message[](#message)

message: string

### name[](#name)

name: string = AbortError.name

### `Optional` stack[](#stack)

stack?: string

### `Static` code[](#code-1)

code: string = 'ERR\_ABORTED'

### `Static` name[](#name-1)

name: string = 'AbortError'

### `Static` `Optional` prepareStackTrace[](#prepareStackTrace)

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

#### Type declaration

*   *   (err, stackTraces): any
    *   #### Parameters
        
        *   err: [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
            
        *   stackTraces: [CallSite](https://www.npmjs.com/package/@types/node)
            \[\]
        
        #### Returns any
        

#### See

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

### `Static` stackTraceLimit[](#stackTraceLimit)

stackTraceLimit: number

Methods
-------

### `Static` captureStackTrace[](#captureStackTrace)

*   captureStackTrace(targetObject, constructorOpt?): void[](#captureStackTrace.captureStackTrace-1)
    
*   Create .stack property on a target object
    
    #### Parameters
    
    *   targetObject: object
    *   `Optional` constructorOpt: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function)
        
    
    #### Returns void
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[constructor](#constructor)
[cause](#cause)
[code](#code)
[message](#message)
[name](#name)
[stack](#stack)
[code](#code-1)
[name](#name-1)
[prepareStackTrace](#prepareStackTrace)
[stackTraceLimit](#stackTraceLimit)
[captureStackTrace](#captureStackTrace)

---

# CloseFailedError | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-store](../modules/interface_store.html)
    
*   [CloseFailedError](interface_store.CloseFailedError.html)
    

Class CloseFailedError
======================

#### Hierarchy

*   [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
    *   CloseFailedError

##### Index

### Constructors

[constructor](interface_store.CloseFailedError.html#constructor)

### Properties

[cause?](interface_store.CloseFailedError.html#cause)
 [code](interface_store.CloseFailedError.html#code)
 [message](interface_store.CloseFailedError.html#message)
 [name](interface_store.CloseFailedError.html#name)
 [stack?](interface_store.CloseFailedError.html#stack)
 [code](interface_store.CloseFailedError.html#code-1)
 [name](interface_store.CloseFailedError.html#name-1)
 [prepareStackTrace?](interface_store.CloseFailedError.html#prepareStackTrace)
 [stackTraceLimit](interface_store.CloseFailedError.html#stackTraceLimit)

### Methods

[captureStackTrace](interface_store.CloseFailedError.html#captureStackTrace)

Constructors
------------

### constructor[](#constructor)

*   new CloseFailedError(message?): [CloseFailedError](interface_store.CloseFailedError.html)
    [](#constructor.new_CloseFailedError)
    
*   #### Parameters
    
    *   message: string = 'Close failed'
    
    #### Returns [CloseFailedError](interface_store.CloseFailedError.html)
    

Properties
----------

### `Optional` cause[](#cause)

cause?: unknown

### code[](#code)

code: string = CloseFailedError.code

### message[](#message)

message: string

### name[](#name)

name: string = CloseFailedError.name

### `Optional` stack[](#stack)

stack?: string

### `Static` code[](#code-1)

code: string = 'ERR\_CLOSE\_FAILED'

### `Static` name[](#name-1)

name: string = 'CloseFailedError'

### `Static` `Optional` prepareStackTrace[](#prepareStackTrace)

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

#### Type declaration

*   *   (err, stackTraces): any
    *   #### Parameters
        
        *   err: [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
            
        *   stackTraces: [CallSite](https://www.npmjs.com/package/@types/node)
            \[\]
        
        #### Returns any
        

#### See

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

### `Static` stackTraceLimit[](#stackTraceLimit)

stackTraceLimit: number

Methods
-------

### `Static` captureStackTrace[](#captureStackTrace)

*   captureStackTrace(targetObject, constructorOpt?): void[](#captureStackTrace.captureStackTrace-1)
    
*   Create .stack property on a target object
    
    #### Parameters
    
    *   targetObject: object
    *   `Optional` constructorOpt: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function)
        
    
    #### Returns void
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[constructor](#constructor)
[cause](#cause)
[code](#code)
[message](#message)
[name](#name)
[stack](#stack)
[code](#code-1)
[name](#name-1)
[prepareStackTrace](#prepareStackTrace)
[stackTraceLimit](#stackTraceLimit)
[captureStackTrace](#captureStackTrace)

---

# GetFailedError | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-store](../modules/interface_store.html)
    
*   [GetFailedError](interface_store.GetFailedError.html)
    

Class GetFailedError
====================

#### Hierarchy

*   [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
    *   GetFailedError

##### Index

### Constructors

[constructor](interface_store.GetFailedError.html#constructor)

### Properties

[cause?](interface_store.GetFailedError.html#cause)
 [code](interface_store.GetFailedError.html#code)
 [message](interface_store.GetFailedError.html#message)
 [name](interface_store.GetFailedError.html#name)
 [stack?](interface_store.GetFailedError.html#stack)
 [code](interface_store.GetFailedError.html#code-1)
 [name](interface_store.GetFailedError.html#name-1)
 [prepareStackTrace?](interface_store.GetFailedError.html#prepareStackTrace)
 [stackTraceLimit](interface_store.GetFailedError.html#stackTraceLimit)

### Methods

[captureStackTrace](interface_store.GetFailedError.html#captureStackTrace)

Constructors
------------

### constructor[](#constructor)

*   new GetFailedError(message?): [GetFailedError](interface_store.GetFailedError.html)
    [](#constructor.new_GetFailedError)
    
*   #### Parameters
    
    *   message: string = 'Get failed'
    
    #### Returns [GetFailedError](interface_store.GetFailedError.html)
    

Properties
----------

### `Optional` cause[](#cause)

cause?: unknown

### code[](#code)

code: string = GetFailedError.code

### message[](#message)

message: string

### name[](#name)

name: string = GetFailedError.name

### `Optional` stack[](#stack)

stack?: string

### `Static` code[](#code-1)

code: string = 'ERR\_GET\_FAILED'

### `Static` name[](#name-1)

name: string = 'GetFailedError'

### `Static` `Optional` prepareStackTrace[](#prepareStackTrace)

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

#### Type declaration

*   *   (err, stackTraces): any
    *   #### Parameters
        
        *   err: [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
            
        *   stackTraces: [CallSite](https://www.npmjs.com/package/@types/node)
            \[\]
        
        #### Returns any
        

#### See

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

### `Static` stackTraceLimit[](#stackTraceLimit)

stackTraceLimit: number

Methods
-------

### `Static` captureStackTrace[](#captureStackTrace)

*   captureStackTrace(targetObject, constructorOpt?): void[](#captureStackTrace.captureStackTrace-1)
    
*   Create .stack property on a target object
    
    #### Parameters
    
    *   targetObject: object
    *   `Optional` constructorOpt: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function)
        
    
    #### Returns void
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[constructor](#constructor)
[cause](#cause)
[code](#code)
[message](#message)
[name](#name)
[stack](#stack)
[code](#code-1)
[name](#name-1)
[prepareStackTrace](#prepareStackTrace)
[stackTraceLimit](#stackTraceLimit)
[captureStackTrace](#captureStackTrace)

---

# DeleteFailedError | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-store](../modules/interface_store.html)
    
*   [DeleteFailedError](interface_store.DeleteFailedError.html)
    

Class DeleteFailedError
=======================

#### Hierarchy

*   [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
    *   DeleteFailedError

##### Index

### Constructors

[constructor](interface_store.DeleteFailedError.html#constructor)

### Properties

[cause?](interface_store.DeleteFailedError.html#cause)
 [code](interface_store.DeleteFailedError.html#code)
 [message](interface_store.DeleteFailedError.html#message)
 [name](interface_store.DeleteFailedError.html#name)
 [stack?](interface_store.DeleteFailedError.html#stack)
 [code](interface_store.DeleteFailedError.html#code-1)
 [name](interface_store.DeleteFailedError.html#name-1)
 [prepareStackTrace?](interface_store.DeleteFailedError.html#prepareStackTrace)
 [stackTraceLimit](interface_store.DeleteFailedError.html#stackTraceLimit)

### Methods

[captureStackTrace](interface_store.DeleteFailedError.html#captureStackTrace)

Constructors
------------

### constructor[](#constructor)

*   new DeleteFailedError(message?): [DeleteFailedError](interface_store.DeleteFailedError.html)
    [](#constructor.new_DeleteFailedError)
    
*   #### Parameters
    
    *   message: string = 'Delete failed'
    
    #### Returns [DeleteFailedError](interface_store.DeleteFailedError.html)
    

Properties
----------

### `Optional` cause[](#cause)

cause?: unknown

### code[](#code)

code: string = DeleteFailedError.code

### message[](#message)

message: string

### name[](#name)

name: string = DeleteFailedError.name

### `Optional` stack[](#stack)

stack?: string

### `Static` code[](#code-1)

code: string = 'ERR\_DELETE\_FAILED'

### `Static` name[](#name-1)

name: string = 'DeleteFailedError'

### `Static` `Optional` prepareStackTrace[](#prepareStackTrace)

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

#### Type declaration

*   *   (err, stackTraces): any
    *   #### Parameters
        
        *   err: [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
            
        *   stackTraces: [CallSite](https://www.npmjs.com/package/@types/node)
            \[\]
        
        #### Returns any
        

#### See

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

### `Static` stackTraceLimit[](#stackTraceLimit)

stackTraceLimit: number

Methods
-------

### `Static` captureStackTrace[](#captureStackTrace)

*   captureStackTrace(targetObject, constructorOpt?): void[](#captureStackTrace.captureStackTrace-1)
    
*   Create .stack property on a target object
    
    #### Parameters
    
    *   targetObject: object
    *   `Optional` constructorOpt: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function)
        
    
    #### Returns void
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[constructor](#constructor)
[cause](#cause)
[code](#code)
[message](#message)
[name](#name)
[stack](#stack)
[code](#code-1)
[name](#name-1)
[prepareStackTrace](#prepareStackTrace)
[stackTraceLimit](#stackTraceLimit)
[captureStackTrace](#captureStackTrace)

---

# HasFailedError | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-store](../modules/interface_store.html)
    
*   [HasFailedError](interface_store.HasFailedError.html)
    

Class HasFailedError
====================

#### Hierarchy

*   [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
    *   HasFailedError

##### Index

### Constructors

[constructor](interface_store.HasFailedError.html#constructor)

### Properties

[cause?](interface_store.HasFailedError.html#cause)
 [code](interface_store.HasFailedError.html#code)
 [message](interface_store.HasFailedError.html#message)
 [name](interface_store.HasFailedError.html#name)
 [stack?](interface_store.HasFailedError.html#stack)
 [code](interface_store.HasFailedError.html#code-1)
 [name](interface_store.HasFailedError.html#name-1)
 [prepareStackTrace?](interface_store.HasFailedError.html#prepareStackTrace)
 [stackTraceLimit](interface_store.HasFailedError.html#stackTraceLimit)

### Methods

[captureStackTrace](interface_store.HasFailedError.html#captureStackTrace)

Constructors
------------

### constructor[](#constructor)

*   new HasFailedError(message?): [HasFailedError](interface_store.HasFailedError.html)
    [](#constructor.new_HasFailedError)
    
*   #### Parameters
    
    *   message: string = 'Has failed'
    
    #### Returns [HasFailedError](interface_store.HasFailedError.html)
    

Properties
----------

### `Optional` cause[](#cause)

cause?: unknown

### code[](#code)

code: string = HasFailedError.code

### message[](#message)

message: string

### name[](#name)

name: string = HasFailedError.name

### `Optional` stack[](#stack)

stack?: string

### `Static` code[](#code-1)

code: string = 'ERR\_HAS\_FAILED'

### `Static` name[](#name-1)

name: string = 'HasFailedError'

### `Static` `Optional` prepareStackTrace[](#prepareStackTrace)

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

#### Type declaration

*   *   (err, stackTraces): any
    *   #### Parameters
        
        *   err: [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
            
        *   stackTraces: [CallSite](https://www.npmjs.com/package/@types/node)
            \[\]
        
        #### Returns any
        

#### See

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

### `Static` stackTraceLimit[](#stackTraceLimit)

stackTraceLimit: number

Methods
-------

### `Static` captureStackTrace[](#captureStackTrace)

*   captureStackTrace(targetObject, constructorOpt?): void[](#captureStackTrace.captureStackTrace-1)
    
*   Create .stack property on a target object
    
    #### Parameters
    
    *   targetObject: object
    *   `Optional` constructorOpt: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function)
        
    
    #### Returns void
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[constructor](#constructor)
[cause](#cause)
[code](#code)
[message](#message)
[name](#name)
[stack](#stack)
[code](#code-1)
[name](#name-1)
[prepareStackTrace](#prepareStackTrace)
[stackTraceLimit](#stackTraceLimit)
[captureStackTrace](#captureStackTrace)

---

# NotFoundError | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-store](../modules/interface_store.html)
    
*   [NotFoundError](interface_store.NotFoundError.html)
    

Class NotFoundError
===================

#### Hierarchy

*   [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
    *   NotFoundError

##### Index

### Constructors

[constructor](interface_store.NotFoundError.html#constructor)

### Properties

[cause?](interface_store.NotFoundError.html#cause)
 [code](interface_store.NotFoundError.html#code)
 [message](interface_store.NotFoundError.html#message)
 [name](interface_store.NotFoundError.html#name)
 [stack?](interface_store.NotFoundError.html#stack)
 [code](interface_store.NotFoundError.html#code-1)
 [name](interface_store.NotFoundError.html#name-1)
 [prepareStackTrace?](interface_store.NotFoundError.html#prepareStackTrace)
 [stackTraceLimit](interface_store.NotFoundError.html#stackTraceLimit)

### Methods

[captureStackTrace](interface_store.NotFoundError.html#captureStackTrace)

Constructors
------------

### constructor[](#constructor)

*   new NotFoundError(message?): [NotFoundError](interface_store.NotFoundError.html)
    [](#constructor.new_NotFoundError)
    
*   #### Parameters
    
    *   message: string = 'Not Found'
    
    #### Returns [NotFoundError](interface_store.NotFoundError.html)
    

Properties
----------

### `Optional` cause[](#cause)

cause?: unknown

### code[](#code)

code: string = NotFoundError.code

### message[](#message)

message: string

### name[](#name)

name: string = NotFoundError.name

### `Optional` stack[](#stack)

stack?: string

### `Static` code[](#code-1)

code: string = 'ERR\_NOT\_FOUND'

### `Static` name[](#name-1)

name: string = 'NotFoundError'

### `Static` `Optional` prepareStackTrace[](#prepareStackTrace)

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

#### Type declaration

*   *   (err, stackTraces): any
    *   #### Parameters
        
        *   err: [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
            
        *   stackTraces: [CallSite](https://www.npmjs.com/package/@types/node)
            \[\]
        
        #### Returns any
        

#### See

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

### `Static` stackTraceLimit[](#stackTraceLimit)

stackTraceLimit: number

Methods
-------

### `Static` captureStackTrace[](#captureStackTrace)

*   captureStackTrace(targetObject, constructorOpt?): void[](#captureStackTrace.captureStackTrace-1)
    
*   Create .stack property on a target object
    
    #### Parameters
    
    *   targetObject: object
    *   `Optional` constructorOpt: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function)
        
    
    #### Returns void
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[constructor](#constructor)
[cause](#cause)
[code](#code)
[message](#message)
[name](#name)
[stack](#stack)
[code](#code-1)
[name](#name-1)
[prepareStackTrace](#prepareStackTrace)
[stackTraceLimit](#stackTraceLimit)
[captureStackTrace](#captureStackTrace)

---

# AbstractSession | Helia

*   [Helia](../index.html)
    
*   [@helia/utils](../modules/_helia_utils.html)
    
*   [AbstractSession](_helia_utils.AbstractSession.html)
    

Class AbstractSession<Provider, RetrieveBlockProgressEvents>`Abstract`
======================================================================

#### Type Parameters

*   Provider
*   RetrieveBlockProgressEvents extends [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
    

#### Hierarchy

*   [TypedEventEmitter](https://libp2p.github.io/js-libp2p/classes/_libp2p_interface.TypedEventEmitter.html)
    <[BlockstoreSessionEvents](../interfaces/_helia_utils.BlockstoreSessionEvents.html)
    <[Provider](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.Provider-1)
    \>\>
    *   AbstractSession

#### Implements

*   [BlockBroker](../interfaces/helia.BlockBroker.html)
    <[RetrieveBlockProgressEvents](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.RetrieveBlockProgressEvents-1)
    \>

##### Index

### Constructors

[constructor](_helia_utils.AbstractSession.html#constructor)

### Properties

[#private](_helia_utils.AbstractSession.html#_private)
 [evictionFilter](_helia_utils.AbstractSession.html#evictionFilter)
 [initialPeerSearchComplete?](_helia_utils.AbstractSession.html#initialPeerSearchComplete)
 [log](_helia_utils.AbstractSession.html#log)
 [logger](_helia_utils.AbstractSession.html#logger)
 [maxProviders](_helia_utils.AbstractSession.html#maxProviders)
 [minProviders](_helia_utils.AbstractSession.html#minProviders)
 [name](_helia_utils.AbstractSession.html#name)
 [providers](_helia_utils.AbstractSession.html#providers)
 [requests](_helia_utils.AbstractSession.html#requests)

### Methods

[addEventListener](_helia_utils.AbstractSession.html#addEventListener)
 [dispatchEvent](_helia_utils.AbstractSession.html#dispatchEvent)
 [equals](_helia_utils.AbstractSession.html#equals)
 [evict](_helia_utils.AbstractSession.html#evict)
 [findNewProviders](_helia_utils.AbstractSession.html#findNewProviders)
 [findProviders](_helia_utils.AbstractSession.html#findProviders)
 [hasProvider](_helia_utils.AbstractSession.html#hasProvider)
 [isEvicted](_helia_utils.AbstractSession.html#isEvicted)
 [listenerCount](_helia_utils.AbstractSession.html#listenerCount)
 [queryProvider](_helia_utils.AbstractSession.html#queryProvider)
 [removeEventListener](_helia_utils.AbstractSession.html#removeEventListener)
 [retrieve](_helia_utils.AbstractSession.html#retrieve)
 [safeDispatchEvent](_helia_utils.AbstractSession.html#safeDispatchEvent)
 [toEvictionKey](_helia_utils.AbstractSession.html#toEvictionKey)

Constructors
------------

### constructor[](#constructor)

*   new AbstractSession<[Provider](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.Provider-1)
    , [RetrieveBlockProgressEvents](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.RetrieveBlockProgressEvents-1)
    \>(components, init): [AbstractSession](_helia_utils.AbstractSession.html)
    <[Provider](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.Provider-1)
    , [RetrieveBlockProgressEvents](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.RetrieveBlockProgressEvents-1)
    \>[](#constructor.new_AbstractSession)
    
*   #### Type Parameters
    
    *   Provider
    *   RetrieveBlockProgressEvents extends [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
        <any, unknown\>
    
    #### Parameters
    
    *   components: [AbstractSessionComponents](../interfaces/_helia_utils.AbstractSessionComponents.html)
        
    *   init: [AbstractCreateSessionOptions](../interfaces/_helia_utils.AbstractCreateSessionOptions.html)
        
    
    #### Returns [AbstractSession](_helia_utils.AbstractSession.html)
    <[Provider](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.Provider-1)
    , [RetrieveBlockProgressEvents](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.RetrieveBlockProgressEvents-1)
    \>
    

Properties
----------

### `Private` #private[](#_private)

#private: any

### `Private` `Readonly` evictionFilter[](#evictionFilter)

evictionFilter: [Filter](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.filters.Filter.html)

### `Private` `Optional` initialPeerSearchComplete[](#initialPeerSearchComplete)

initialPeerSearchComplete?: [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<void\>

### `Protected` log[](#log)

log: [Logger](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Logger.html)

### `Protected` logger[](#logger)

logger: [ComponentLogger](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.ComponentLogger.html)

### `Private` `Readonly` maxProviders[](#maxProviders)

maxProviders: number

### `Private` `Readonly` minProviders[](#minProviders)

minProviders: number

### `Private` `Readonly` name[](#name)

name: string

### `Readonly` providers[](#providers)

providers: [Provider](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.Provider-1)
\[\]

### `Private` `Readonly` requests[](#requests)

requests: [Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)
<string, [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
<[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
\>\>

Methods
-------

### addEventListener[](#addEventListener)

*   addEventListener<[K](_helia_utils.AbstractSession.html#addEventListener.addEventListener-1.K)
    \>(type, listener, options?): void[](#addEventListener.addEventListener-1)
    
*   #### Type Parameters
    
    *   K extends "provider"
    
    #### Parameters
    
    *   type: [K](_helia_utils.AbstractSession.html#addEventListener.addEventListener-1.K)
        
    *   listener: null | [EventHandler](https://libp2p.github.io/js-libp2p/types/_libp2p_interface.EventHandler.html)
        <[BlockstoreSessionEvents](../interfaces/_helia_utils.BlockstoreSessionEvents.html)
        <[Provider](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.Provider-1)
        \>\[[K](_helia_utils.AbstractSession.html#addEventListener.addEventListener-1.K)\
        \]\>
    *   `Optional` options: boolean | AddEventListenerOptions
    
    #### Returns void
    

### dispatchEvent[](#dispatchEvent)

*   dispatchEvent(event): boolean[](#dispatchEvent.dispatchEvent-1)
    
*   #### Parameters
    
    *   event: [Event](https://developer.mozilla.org/docs/Web/API/Event)
        
    
    #### Returns boolean
    

### `Abstract` equals[](#equals)

*   equals(providerA, providerB): boolean[](#equals.equals-1)
    
*   Return `true` if we consider one provider to be the same as another
    
    #### Parameters
    
    *   providerA: [Provider](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.Provider-1)
        
    *   providerB: [Provider](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.Provider-1)
        
    
    #### Returns boolean
    

### evict[](#evict)

*   evict(provider): void[](#evict.evict-1)
    
*   #### Parameters
    
    *   provider: [Provider](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.Provider-1)
        
    
    #### Returns void
    

### `Abstract` findNewProviders[](#findNewProviders)

*   findNewProviders(cid, options): [AsyncGenerator](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator)
    <[Provider](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.Provider-1)
    , any, unknown\>[](#findNewProviders.findNewProviders-1)
    
*   This method should search for new providers and yield them.
    
    #### Parameters
    
    *   cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   options: [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
        
    
    #### Returns [AsyncGenerator](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator)
    <[Provider](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.Provider-1)
    , any, unknown\>
    

### `Private` findProviders[](#findProviders)

*   findProviders(cid, count, options): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#findProviders.findProviders-1)
    
*   #### Parameters
    
    *   cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   count: number
    *   options: [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
        
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    

### hasProvider[](#hasProvider)

*   hasProvider(provider): boolean[](#hasProvider.hasProvider-1)
    
*   #### Parameters
    
    *   provider: [Provider](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.Provider-1)
        
    
    #### Returns boolean
    

### isEvicted[](#isEvicted)

*   isEvicted(provider): boolean[](#isEvicted.isEvicted-1)
    
*   #### Parameters
    
    *   provider: [Provider](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.Provider-1)
        
    
    #### Returns boolean
    

### listenerCount[](#listenerCount)

*   listenerCount(type): number[](#listenerCount.listenerCount-1)
    
*   #### Parameters
    
    *   type: string
    
    #### Returns number
    

### `Abstract` queryProvider[](#queryProvider)

*   queryProvider(cid, provider, options): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    \>[](#queryProvider.queryProvider-1)
    
*   The subclass should contact the provider and request the block from it.
    
    If the provider cannot provide the block an error should be thrown.
    
    The provider will then be excluded from ongoing queries.
    
    #### Parameters
    
    *   cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   provider: [Provider](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.Provider-1)
        
    *   options: [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
        
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    \>
    

### removeEventListener[](#removeEventListener)

*   removeEventListener<[K](_helia_utils.AbstractSession.html#removeEventListener.removeEventListener-1.K-1)
    \>(type, listener?, options?): void[](#removeEventListener.removeEventListener-1)
    
*   #### Type Parameters
    
    *   K extends "provider"
    
    #### Parameters
    
    *   type: [K](_helia_utils.AbstractSession.html#removeEventListener.removeEventListener-1.K-1)
        
    *   `Optional` listener: null | [EventHandler](https://libp2p.github.io/js-libp2p/types/_libp2p_interface.EventHandler.html)
        <[BlockstoreSessionEvents](../interfaces/_helia_utils.BlockstoreSessionEvents.html)
        <[Provider](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.Provider-1)
        \>\[[K](_helia_utils.AbstractSession.html#removeEventListener.removeEventListener-1.K-1)\
        \]\>
    *   `Optional` options: boolean | EventListenerOptions
    
    #### Returns void
    

### retrieve[](#retrieve)

*   retrieve(cid, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    \>[](#retrieve.retrieve-1)
    
*   Retrieve a block from a source
    
    #### Parameters
    
    *   cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   options: [BlockRetrievalOptions](../interfaces/helia.BlockRetrievalOptions.html)
        <[RetrieveBlockProgressEvents](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.RetrieveBlockProgressEvents-1)
        \> = {}
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    \>
    

### safeDispatchEvent[](#safeDispatchEvent)

*   safeDispatchEvent<[Detail](_helia_utils.AbstractSession.html#safeDispatchEvent.safeDispatchEvent-1.Detail)
    \>(type, detail?): boolean[](#safeDispatchEvent.safeDispatchEvent-1)
    
*   #### Type Parameters
    
    *   Detail
    
    #### Parameters
    
    *   type: "provider"
    *   `Optional` detail: CustomEventInit<[Detail](_helia_utils.AbstractSession.html#safeDispatchEvent.safeDispatchEvent-1.Detail)
        \>
    
    #### Returns boolean
    

### `Abstract` toEvictionKey[](#toEvictionKey)

*   toEvictionKey(provider): string | [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    [](#toEvictionKey.toEvictionKey-1)
    
*   Turn a provider into a concise Uint8Array representation for use in a Bloom filter
    
    #### Parameters
    
    *   provider: [Provider](_helia_utils.AbstractSession.html#constructor.new_AbstractSession.Provider-1)
        
    
    #### Returns string | [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[constructor](#constructor)
[#private](#_private)
[evictionFilter](#evictionFilter)
[initialPeerSearchComplete](#initialPeerSearchComplete)
[log](#log)
[logger](#logger)
[maxProviders](#maxProviders)
[minProviders](#minProviders)
[name](#name)
[providers](#providers)
[requests](#requests)
[addEventListener](#addEventListener)
[dispatchEvent](#dispatchEvent)
[equals](#equals)
[evict](#evict)
[findNewProviders](#findNewProviders)
[findProviders](#findProviders)
[hasProvider](#hasProvider)
[isEvicted](#isEvicted)
[listenerCount](#listenerCount)
[queryProvider](#queryProvider)
[removeEventListener](#removeEventListener)
[retrieve](#retrieve)
[safeDispatchEvent](#safeDispatchEvent)
[toEvictionKey](#toEvictionKey)

---

# Helia | Helia

*   [Helia](../index.html)
    
*   [@helia/utils](../modules/_helia_utils.html)
    
*   [Helia](_helia_utils.Helia.html)
    

Class Helia
===========

The API presented by a Helia node

#### Implements

*   [Helia](../interfaces/helia.Helia.html)
    

##### Index

### Constructors

[constructor](_helia_utils.Helia.html#constructor)

### Properties

[blockstore](_helia_utils.Helia.html#blockstore)
 [datastore](_helia_utils.Helia.html#datastore)
 [dns](_helia_utils.Helia.html#dns)
 [getCodec](_helia_utils.Helia.html#getCodec)
 [getHasher](_helia_utils.Helia.html#getHasher)
 [log](_helia_utils.Helia.html#log)
 [logger](_helia_utils.Helia.html#logger)
 [metrics?](_helia_utils.Helia.html#metrics)
 [pins](_helia_utils.Helia.html#pins)
 [routing](_helia_utils.Helia.html#routing)

### Methods

[gc](_helia_utils.Helia.html#gc)
 [start](_helia_utils.Helia.html#start)
 [stop](_helia_utils.Helia.html#stop)

Constructors
------------

### constructor[](#constructor)

*   new Helia(init): [Helia](_helia_utils.Helia.html)
    [](#constructor.new_Helia)
    
*   #### Parameters
    
    *   init: [HeliaInit](../interfaces/_helia_utils.HeliaInit.html)
        
    
    #### Returns [Helia](_helia_utils.Helia.html)
    

Properties
----------

### blockstore[](#blockstore)

blockstore: [BlockStorage](_helia_utils.BlockStorage.html)

Where the blocks are stored

### datastore[](#datastore)

datastore: [Datastore](https://ipfs.github.io/js-stores/interfaces/interface_datastore.index.Datastore.html)
<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}\>

A key/value store

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

#### Type declaration

### dns[](#dns)

dns: [DNS](https://multiformats.github.io/js-dns/interfaces/index.DNS.html)

The DNS property can be used to perform lookups of various record types and will use a resolver appropriate to the current platform.

### getCodec[](#getCodec)

getCodec: [CodecLoader](../interfaces/helia.CodecLoader.html)

Load an IPLD codec. Implementations may return a promise if, for example, the codec is being fetched from the network.

### getHasher[](#getHasher)

getHasher: [HasherLoader](../interfaces/helia.HasherLoader.html)

Hashers can be used to hash a piece of data with the specified hashing algorithm. Implementations may return a promise if, for example, the hasher is being fetched from the network.

### `Private` `Readonly` log[](#log)

log: [Logger](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Logger.html)

### logger[](#logger)

logger: [ComponentLogger](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.ComponentLogger.html)

A logging component that can be reused by consumers

### `Optional` metrics[](#metrics)

metrics?: [Metrics](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Metrics.html)

A metrics object that can be used to collected arbitrary stats about node usage.

### pins[](#pins)

pins: [Pins](../interfaces/helia.Pins.html)

Pinning operations for blocks in the blockstore

### routing[](#routing)

routing: [Routing](../interfaces/helia.Routing.html)

The routing component allows performing operations such as looking up content providers, information about peers, etc.

Methods
-------

### gc[](#gc)

*   gc(options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#gc.gc-1)
    
*   Remove any unpinned blocks from the blockstore
    
    #### Parameters
    
    *   options: [GCOptions](../interfaces/helia.GCOptions.html)
         = {}
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    

### start[](#start)

*   start(): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#start.start-1)
    
*   Starts the Helia node
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    

### stop[](#stop)

*   stop(): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#stop.stop-1)
    
*   Stops the Helia node
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[constructor](#constructor)
[blockstore](#blockstore)
[datastore](#datastore)
[dns](#dns)
[getCodec](#getCodec)
[getHasher](#getHasher)
[log](#log)
[logger](#logger)
[metrics](#metrics)
[pins](#pins)
[routing](#routing)
[gc](#gc)
[start](#start)
[stop](#stop)

---

# OpenFailedError | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-store](../modules/interface_store.html)
    
*   [OpenFailedError](interface_store.OpenFailedError.html)
    

Class OpenFailedError
=====================

#### Hierarchy

*   [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
    *   OpenFailedError

##### Index

### Constructors

[constructor](interface_store.OpenFailedError.html#constructor)

### Properties

[cause?](interface_store.OpenFailedError.html#cause)
 [code](interface_store.OpenFailedError.html#code)
 [message](interface_store.OpenFailedError.html#message)
 [name](interface_store.OpenFailedError.html#name)
 [stack?](interface_store.OpenFailedError.html#stack)
 [code](interface_store.OpenFailedError.html#code-1)
 [name](interface_store.OpenFailedError.html#name-1)
 [prepareStackTrace?](interface_store.OpenFailedError.html#prepareStackTrace)
 [stackTraceLimit](interface_store.OpenFailedError.html#stackTraceLimit)

### Methods

[captureStackTrace](interface_store.OpenFailedError.html#captureStackTrace)

Constructors
------------

### constructor[](#constructor)

*   new OpenFailedError(message?): [OpenFailedError](interface_store.OpenFailedError.html)
    [](#constructor.new_OpenFailedError)
    
*   #### Parameters
    
    *   message: string = 'Open failed'
    
    #### Returns [OpenFailedError](interface_store.OpenFailedError.html)
    

Properties
----------

### `Optional` cause[](#cause)

cause?: unknown

### code[](#code)

code: string = OpenFailedError.code

### message[](#message)

message: string

### name[](#name)

name: string = OpenFailedError.name

### `Optional` stack[](#stack)

stack?: string

### `Static` code[](#code-1)

code: string = 'ERR\_OPEN\_FAILED'

### `Static` name[](#name-1)

name: string = 'OpenFailedError'

### `Static` `Optional` prepareStackTrace[](#prepareStackTrace)

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

#### Type declaration

*   *   (err, stackTraces): any
    *   #### Parameters
        
        *   err: [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
            
        *   stackTraces: [CallSite](https://www.npmjs.com/package/@types/node)
            \[\]
        
        #### Returns any
        

#### See

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

### `Static` stackTraceLimit[](#stackTraceLimit)

stackTraceLimit: number

Methods
-------

### `Static` captureStackTrace[](#captureStackTrace)

*   captureStackTrace(targetObject, constructorOpt?): void[](#captureStackTrace.captureStackTrace-1)
    
*   Create .stack property on a target object
    
    #### Parameters
    
    *   targetObject: object
    *   `Optional` constructorOpt: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function)
        
    
    #### Returns void
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[constructor](#constructor)
[cause](#cause)
[code](#code)
[message](#message)
[name](#name)
[stack](#stack)
[code](#code-1)
[name](#name-1)
[prepareStackTrace](#prepareStackTrace)
[stackTraceLimit](#stackTraceLimit)
[captureStackTrace](#captureStackTrace)

---

# AbstractSessionComponents | Helia

*   [Helia](../index.html)
    
*   [@helia/utils](../modules/_helia_utils.html)
    
*   [AbstractSessionComponents](_helia_utils.AbstractSessionComponents.html)
    

Interface AbstractSessionComponents
===================================

interface AbstractSessionComponents {  
    [logger](_helia_utils.AbstractSessionComponents.html#logger)
: [ComponentLogger](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.ComponentLogger.html)
;  
}

##### Index

### Properties

[logger](_helia_utils.AbstractSessionComponents.html#logger)

Properties
----------

### logger[](#logger)

logger: [ComponentLogger](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.ComponentLogger.html)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[logger](#logger)

---

# BlockStorage | Helia

*   [Helia](../index.html)
    
*   [@helia/utils](../modules/_helia_utils.html)
    
*   [BlockStorage](_helia_utils.BlockStorage.html)
    

Class BlockStorage
==================

BlockStorage is a hybrid blockstore that puts/gets blocks from a configured blockstore (that may be on disk, s3, or something else). If the blocks are not present Bitswap will be used to fetch them from network peers.

#### Implements

*   [Blocks](../interfaces/helia.Blocks.html)
    
*   [Startable](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.Startable.html)
    

##### Index

### Constructors

[constructor](_helia_utils.BlockStorage.html#constructor)

### Properties

[child](_helia_utils.BlockStorage.html#child)
 [lock](_helia_utils.BlockStorage.html#lock)
 [pins](_helia_utils.BlockStorage.html#pins)
 [started](_helia_utils.BlockStorage.html#started)

### Methods

[createSession](_helia_utils.BlockStorage.html#createSession)
 [delete](_helia_utils.BlockStorage.html#delete)
 [deleteMany](_helia_utils.BlockStorage.html#deleteMany)
 [get](_helia_utils.BlockStorage.html#get)
 [getAll](_helia_utils.BlockStorage.html#getAll)
 [getMany](_helia_utils.BlockStorage.html#getMany)
 [has](_helia_utils.BlockStorage.html#has)
 [isStarted](_helia_utils.BlockStorage.html#isStarted)
 [put](_helia_utils.BlockStorage.html#put)
 [putMany](_helia_utils.BlockStorage.html#putMany)
 [start](_helia_utils.BlockStorage.html#start)
 [stop](_helia_utils.BlockStorage.html#stop)
 [unwrap](_helia_utils.BlockStorage.html#unwrap)

Constructors
------------

### constructor[](#constructor)

*   new BlockStorage(blockstore, pins, options?): [BlockStorage](_helia_utils.BlockStorage.html)
    [](#constructor.new_BlockStorage)
    
*   Create a new BlockStorage
    
    #### Parameters
    
    *   blockstore: [Blocks](../interfaces/helia.Blocks.html)
        
    *   pins: [Pins](../interfaces/helia.Pins.html)
        
    *   options: [BlockStorageInit](../interfaces/_helia_utils.BlockStorageInit.html)
         = {}
    
    #### Returns [BlockStorage](_helia_utils.BlockStorage.html)
    

Properties
----------

### `Private` `Readonly` child[](#child)

child: [Blocks](../interfaces/helia.Blocks.html)

### lock[](#lock)

lock: [Mortice](https://achingbrain.github.io/mortice/interfaces/Mortice.html)

### `Private` `Readonly` pins[](#pins)

pins: [Pins](../interfaces/helia.Pins.html)

### `Private` started[](#started)

started: boolean

Methods
-------

### createSession[](#createSession)

*   createSession(root, options?): [SessionBlockstore](../interfaces/helia.SessionBlockstore.html)
    [](#createSession.createSession-1)
    
*   #### Parameters
    
    *   root: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   `Optional` options: [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
        
    
    #### Returns [SessionBlockstore](../interfaces/helia.SessionBlockstore.html)
    

### delete[](#delete)

*   delete(cid, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#delete.delete-1)
    
*   Delete a block from the blockstore
    
    #### Parameters
    
    *   cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   options: [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[DeleteBlockProgressEvents](../types/helia.DeleteBlockProgressEvents.html)
        \> = {}
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    

### deleteMany[](#deleteMany)

*   deleteMany(cids, options?): AsyncIterable<[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>[](#deleteMany.deleteMany-1)
    
*   Delete multiple blocks from the blockstore
    
    #### Parameters
    
    *   cids: [AwaitIterable](../types/helia.AwaitIterable.html)
        <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>\>
    *   options: [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[DeleteManyBlocksProgressEvents](../types/helia.DeleteManyBlocksProgressEvents.html)
        \> = {}
    
    #### Returns AsyncIterable<[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>
    

### get[](#get)

*   get(cid, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    \>[](#get.get-1)
    
*   Get a block by cid
    
    #### Parameters
    
    *   cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   options: [GetOfflineOptions](../interfaces/helia.GetOfflineOptions.html)
         & [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[GetBlockProgressEvents](../types/helia.GetBlockProgressEvents.html)
        \> = {}
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
    \>
    

### getAll[](#getAll)

*   getAll(options?): AsyncIterable<[Pair](../interfaces/helia.Pair.html)
    \>[](#getAll.getAll-1)
    
*   Retrieve all cid/block pairs from the blockstore as an unordered iterable
    
    #### Parameters
    
    *   options: [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[GetAllBlocksProgressEvents](../types/helia.GetAllBlocksProgressEvents.html)
        \> = {}
    
    #### Returns AsyncIterable<[Pair](../interfaces/helia.Pair.html)
    \>
    
    #### Example
    
        for await (const { multihash, block } of store.getAll()) {  console.log('got:', multihash, block)  // => got MultihashDigest('Qmfoo') Uint8Array[...]}
        
    

### getMany[](#getMany)

*   getMany(cids, options?): AsyncIterable<[Pair](../interfaces/helia.Pair.html)
    \>[](#getMany.getMany-1)
    
*   Get multiple blocks back from an (async) iterable of cids
    
    #### Parameters
    
    *   cids: [AwaitIterable](../types/helia.AwaitIterable.html)
        <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>\>
    *   options: [GetOfflineOptions](../interfaces/helia.GetOfflineOptions.html)
         & [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[GetManyBlocksProgressEvents](../types/helia.GetManyBlocksProgressEvents.html)
        \> = {}
    
    #### Returns AsyncIterable<[Pair](../interfaces/helia.Pair.html)
    \>
    

### has[](#has)

*   has(cid, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <boolean\>[](#has.has-1)
    
*   Check for the existence of a value for the passed key
    
    #### Parameters
    
    *   cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   options: [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
         = {}
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <boolean\>
    
    #### Example
    
        const exists = await store.has(new Key('awesome'))if (exists) { console.log('it is there')} else { console.log('it is not there')}
        
    

### isStarted[](#isStarted)

*   isStarted(): boolean[](#isStarted.isStarted-1)
    
*   #### Returns boolean
    

### put[](#put)

*   put(cid, block, options?): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>[](#put.put-1)
    
*   Put a block to the underlying datastore
    
    #### Parameters
    
    *   cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>
    *   block: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
        
    *   options: [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[PutBlockProgressEvents](../types/helia.PutBlockProgressEvents.html)
        \> = {}
    
    #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>
    

### putMany[](#putMany)

*   putMany(blocks, options?): AsyncIterable<[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>[](#putMany.putMany-1)
    
*   Put a multiple blocks to the underlying datastore
    
    #### Parameters
    
    *   blocks: [AwaitIterable](../types/helia.AwaitIterable.html)
        <{  
            block: [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
        ;  
            cid: [CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
        <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
        \>;  
        }\>
    *   options: [AbortOptions](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.AbortOptions.html)
         & [ProgressOptions](https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html)
        <[PutManyBlocksProgressEvents](../types/helia.PutManyBlocksProgressEvents.html)
        \> = {}
    
    #### Returns AsyncIterable<[CID](https://multiformats.github.io/js-multiformats/classes/cid.CID.html)
    <unknown, number, number, [Version](https://multiformats.github.io/js-multiformats/types/link_interface.Version.html)
    \>\>
    

### start[](#start)

*   start(): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#start.start-1)
    
*   #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    

### stop[](#stop)

*   stop(): [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>[](#stop.stop-1)
    
*   #### Returns [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
    <void\>
    

### unwrap[](#unwrap)

*   unwrap(): [Blockstore](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Blockstore.html)
    <{}, {}, {}, {}, {}, {}, {}, {}\>[](#unwrap.unwrap-1)
    
*   #### Returns [Blockstore](https://ipfs.github.io/js-stores/interfaces/interface_blockstore.Blockstore.html)
    <{}, {}, {}, {}, {}, {}, {}, {}\>
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[constructor](#constructor)
[child](#child)
[lock](#lock)
[pins](#pins)
[started](#started)
[createSession](#createSession)
[delete](#delete)
[deleteMany](#deleteMany)
[get](#get)
[getAll](#getAll)
[getMany](#getMany)
[has](#has)
[isStarted](#isStarted)
[put](#put)
[putMany](#putMany)
[start](#start)
[stop](#stop)
[unwrap](#unwrap)

---

# BlockStorageInit | Helia

*   [Helia](../index.html)
    
*   [@helia/utils](../modules/_helia_utils.html)
    
*   [BlockStorageInit](_helia_utils.BlockStorageInit.html)
    

Interface BlockStorageInit
==========================

interface BlockStorageInit {  
    [holdGcLock](_helia_utils.BlockStorageInit.html#holdGcLock)
?: boolean;  
}

##### Index

### Properties

[holdGcLock?](_helia_utils.BlockStorageInit.html#holdGcLock)

Properties
----------

### `Optional` holdGcLock[](#holdGcLock)

holdGcLock?: boolean

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[holdGcLock](#holdGcLock)

---

# AbstractCreateSessionOptions | Helia

*   [Helia](../index.html)
    
*   [@helia/utils](../modules/_helia_utils.html)
    
*   [AbstractCreateSessionOptions](_helia_utils.AbstractCreateSessionOptions.html)
    

Interface AbstractCreateSessionOptions
======================================

interface AbstractCreateSessionOptions {  
    [maxProviders](_helia_utils.AbstractCreateSessionOptions.html#maxProviders)
?: number;  
    [minProviders](_helia_utils.AbstractCreateSessionOptions.html#minProviders)
?: number;  
    [name](_helia_utils.AbstractCreateSessionOptions.html#name)
: string;  
    [onProgress](_helia_utils.AbstractCreateSessionOptions.html#onProgress)
?: ((evt) => void);  
    [signal](_helia_utils.AbstractCreateSessionOptions.html#signal)
?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)
;  
}

#### Hierarchy ([view full](../hierarchy.html#@helia/utils.AbstractCreateSessionOptions)
)

*   [CreateSessionOptions](helia.CreateSessionOptions.html)
    *   AbstractCreateSessionOptions

##### Index

### Properties

[maxProviders?](_helia_utils.AbstractCreateSessionOptions.html#maxProviders)
 [minProviders?](_helia_utils.AbstractCreateSessionOptions.html#minProviders)
 [name](_helia_utils.AbstractCreateSessionOptions.html#name)
 [onProgress?](_helia_utils.AbstractCreateSessionOptions.html#onProgress)
 [signal?](_helia_utils.AbstractCreateSessionOptions.html#signal)

Properties
----------

### `Optional` maxProviders[](#maxProviders)

maxProviders?: number

The maximum number of providers for the root CID to be added to a session.

#### Default

    5
    

### `Optional` minProviders[](#minProviders)

minProviders?: number

The minimum number of providers for the root CID that are required for successful session creation.

The session will become usable once this many providers have been discovered, up to `maxProviders` providers will continue to be added.

#### Default

    1
    

### name[](#name)

name: string

### `Optional` onProgress[](#onProgress)

onProgress?: ((evt) => void)

#### Type declaration

*   *   (evt): void
    *   #### Parameters
        
        *   evt: [ProgressEvent](https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html)
            <any, any\>
        
        #### Returns void
        

### `Optional` signal[](#signal)

signal?: [AbortSignal](https://developer.mozilla.org/docs/Web/API/AbortSignal)

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[maxProviders](#maxProviders)
[minProviders](#minProviders)
[name](#name)
[onProgress](#onProgress)
[signal](#signal)

---

# BlockstoreSessionEvents | Helia

*   [Helia](../index.html)
    
*   [@helia/utils](../modules/_helia_utils.html)
    
*   [BlockstoreSessionEvents](_helia_utils.BlockstoreSessionEvents.html)
    

Interface BlockstoreSessionEvents<Provider>
===========================================

interface BlockstoreSessionEvents<[Provider](_helia_utils.BlockstoreSessionEvents.html#Provider)
\> {  
    [provider](_helia_utils.BlockstoreSessionEvents.html#provider-1)
: [CustomEvent](https://developer.mozilla.org/docs/Web/API/CustomEvent)
<[Provider](_helia_utils.BlockstoreSessionEvents.html#Provider)
\>;  
}

#### Type Parameters

*   Provider

##### Index

### Properties

[provider](_helia_utils.BlockstoreSessionEvents.html#provider-1)

Properties
----------

### provider[](#provider-1)

provider: [CustomEvent](https://developer.mozilla.org/docs/Web/API/CustomEvent)
<[Provider](_helia_utils.BlockstoreSessionEvents.html#Provider)
\>

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[provider](#provider-1)

---

# PutFailedError | IPFS Stores

*   [IPFS Stores](../index.html)
    
*   [interface-store](../modules/interface_store.html)
    
*   [PutFailedError](interface_store.PutFailedError.html)
    

Class PutFailedError
====================

#### Hierarchy

*   [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
    *   PutFailedError

##### Index

### Constructors

[constructor](interface_store.PutFailedError.html#constructor)

### Properties

[cause?](interface_store.PutFailedError.html#cause)
 [code](interface_store.PutFailedError.html#code)
 [message](interface_store.PutFailedError.html#message)
 [name](interface_store.PutFailedError.html#name)
 [stack?](interface_store.PutFailedError.html#stack)
 [code](interface_store.PutFailedError.html#code-1)
 [name](interface_store.PutFailedError.html#name-1)
 [prepareStackTrace?](interface_store.PutFailedError.html#prepareStackTrace)
 [stackTraceLimit](interface_store.PutFailedError.html#stackTraceLimit)

### Methods

[captureStackTrace](interface_store.PutFailedError.html#captureStackTrace)

Constructors
------------

### constructor[](#constructor)

*   new PutFailedError(message?): [PutFailedError](interface_store.PutFailedError.html)
    [](#constructor.new_PutFailedError)
    
*   #### Parameters
    
    *   message: string = 'Put failed'
    
    #### Returns [PutFailedError](interface_store.PutFailedError.html)
    

Properties
----------

### `Optional` cause[](#cause)

cause?: unknown

### code[](#code)

code: string = PutFailedError.code

### message[](#message)

message: string

### name[](#name)

name: string = PutFailedError.name

### `Optional` stack[](#stack)

stack?: string

### `Static` code[](#code-1)

code: string = 'ERR\_PUT\_FAILED'

### `Static` name[](#name-1)

name: string = 'PutFailedError'

### `Static` `Optional` prepareStackTrace[](#prepareStackTrace)

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

#### Type declaration

*   *   (err, stackTraces): any
    *   #### Parameters
        
        *   err: [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)
            
        *   stackTraces: [CallSite](https://www.npmjs.com/package/@types/node)
            \[\]
        
        #### Returns any
        

#### See

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

### `Static` stackTraceLimit[](#stackTraceLimit)

stackTraceLimit: number

Methods
-------

### `Static` captureStackTrace[](#captureStackTrace)

*   captureStackTrace(targetObject, constructorOpt?): void[](#captureStackTrace.captureStackTrace-1)
    
*   Create .stack property on a target object
    
    #### Parameters
    
    *   targetObject: object
    *   `Optional` constructorOpt: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function)
        
    
    #### Returns void
    

### Settings

#### Member Visibility

*   Protected
*   Private
*   Inherited
*   External

#### Theme

OSLightDark

### On This Page

[constructor](#constructor)
[cause](#cause)
[code](#code)
[message](#message)
[name](#name)
[stack](#stack)
[code](#code-1)
[name](#name-1)
[prepareStackTrace](#prepareStackTrace)
[stackTraceLimit](#stackTraceLimit)
[captureStackTrace](#captureStackTrace)

---