Module index

The API defined by a Helia node

Example

import type { Helia } from '@helia/interface'

export function doSomething(helia: Helia) {
  // use helia node functions here
}

Classes

InsufficientProvidersError
InvalidCodecError
NoEvictionError
NoRoutersAvailableError
UnknownCodecError
UnknownCryptoError
UnknownHashAlgorithmError

Interfaces

CodecLoader
Crypto
CryptoLoader
GCOptions
GraphNode
GraphWalker
GraphWalkerComponents
GraphWalkerInit
HasherLoader
Helia
HeliaEvents
HeliaMixin
InputPair
Keychain
NodeInfo
Pair
PrivateKey
PublicKey
WalkOptions

Type Aliases

GcEvents
GraphWalkerFactory

Functions

isPrivateKey
isPublicKey

References

AddOptions → AddOptions
AddPinEvents → AddPinEvents
BlockAnnounceOptions → BlockAnnounceOptions
BlockBroker → BlockBroker
BlockBrokerConnectedProgressEvent → BlockBrokerConnectedProgressEvent
BlockBrokerConnectProgressEvent → BlockBrokerConnectProgressEvent
BlockBrokerGetBlockProgressEvents → BlockBrokerGetBlockProgressEvents
BlockBrokerReceiveBlockProgressEvent → BlockBrokerReceiveBlockProgressEvent
BlockBrokerRequestBlockProgressEvent → BlockBrokerRequestBlockProgressEvent
BlockRetrievalOptions → BlockRetrievalOptions
Blocks → Blocks
Capability → Capability
CreateSessionOptions → CreateSessionOptions
DEFAULT_CID_PEER_FILTER_SIZE → DEFAULT_CID_PEER_FILTER_SIZE
DEFAULT_SESSION_MAX_PROVIDERS → DEFAULT_SESSION_MAX_PROVIDERS
DEFAULT_SESSION_MIN_PROVIDERS → DEFAULT_SESSION_MIN_PROVIDERS
DeleteBlockProgressEvents → DeleteBlockProgressEvents
DeleteManyBlocksProgressEvents → DeleteManyBlocksProgressEvents
GetAllBlocksProgressEvents → GetAllBlocksProgressEvents
GetBlockProgressEvents → GetBlockProgressEvents
GetManyBlocksProgressEvents → GetManyBlocksProgressEvents
GetOfflineOptions → GetOfflineOptions
HasBlockProgressEvents → HasBlockProgressEvents
IsPinnedOptions → IsPinnedOptions
LsOptions → LsOptions
Peer → Peer
Pin → Pin
Pins → Pins
PinType → PinType
Provider → Provider
ProviderOptions → ProviderOptions
PutBlockProgressEvents → PutBlockProgressEvents
PutManyBlocksProgressEvents → PutManyBlocksProgressEvents
RmOptions → RmOptions
Router → Router
Routing → Routing
RoutingCancelReprovideEndEvent → RoutingCancelReprovideEndEvent
RoutingCancelReprovideProgressEvents → RoutingCancelReprovideProgressEvents
RoutingCancelReprovideStartEvent → RoutingCancelReprovideStartEvent
RoutingFindPeerEndEvent → RoutingFindPeerEndEvent
RoutingFindPeerProgressEvents → RoutingFindPeerProgressEvents
RoutingFindPeerStartEvent → RoutingFindPeerStartEvent
RoutingFindProvidersDelegatedHttpRoutingProvider → RoutingFindProvidersDelegatedHttpRoutingProvider
RoutingFindProvidersEndEvent → RoutingFindProvidersEndEvent
RoutingFindProvidersHttpGatewayProvider → RoutingFindProvidersHttpGatewayProvider
RoutingFindProvidersLibp2pProvider → RoutingFindProvidersLibp2pProvider
RoutingFindProvidersProgressEvents → RoutingFindProvidersProgressEvents
RoutingFindProvidersProviderEvent → RoutingFindProvidersProviderEvent
RoutingFindProvidersStartEvent → RoutingFindProvidersStartEvent
RoutingGetClosestPeersEndEvent → RoutingGetClosestPeersEndEvent
RoutingGetClosestPeersProgressEvents → RoutingGetClosestPeersProgressEvents
RoutingGetClosestPeersStartEvent → RoutingGetClosestPeersStartEvent
RoutingGetEndEvent → RoutingGetEndEvent
RoutingGetProgressEvents → RoutingGetProgressEvents
RoutingGetStartEvent → RoutingGetStartEvent
RoutingOptions → RoutingOptions
RoutingProvideEndEvent → RoutingProvideEndEvent
RoutingProvideProgressEvents → RoutingProvideProgressEvents
RoutingProvideStartEvent → RoutingProvideStartEvent
RoutingPutEndEvent → RoutingPutEndEvent
RoutingPutProgressEvents → RoutingPutProgressEvents
RoutingPutStartEvent → RoutingPutStartEvent
SessionBlockBroker → SessionBlockBroker
SessionBlockstore → SessionBlockstore

Module index

Example

Classes

Interfaces

Type Aliases

Functions

References

Settings

On This Page