Interface Fetch

interface Fetch {
    fetch(
        peer: PeerId,
        key: string | Uint8Array<ArrayBufferLike>,
        options?: AbortOptions,
    ): Promise<undefined | Uint8Array<ArrayBufferLike>>;
    registerLookupFunction(prefix: string, lookup: LookupFunction): void;
    unregisterLookupFunction(prefix: string, lookup?: LookupFunction): void;
}

Index

Methods

fetch registerLookupFunction unregisterLookupFunction

Methods

fetch

fetch(
    peer: PeerId,
    key: string | Uint8Array<ArrayBufferLike>,
    options?: AbortOptions,
): Promise<undefined | Uint8Array<ArrayBufferLike>>
Sends a request to fetch the value associated with the given key from the given peer
Parameters
- peer: PeerId
- key: string | Uint8Array<ArrayBufferLike>
- Optionaloptions: AbortOptions
Returns Promise<undefined | Uint8Array<ArrayBufferLike>>
- Defined in index.ts:81

registerLookupFunction

registerLookupFunction(prefix: string, lookup: LookupFunction): void
Registers a new lookup callback that can map keys to values, for a given set of keys that share the same prefix
Parameters
- prefix: string
- lookup: LookupFunction
Returns void
Example
```
// ...
libp2p.services.fetch.registerLookupFunction('/prefix', (key) => { ... })
```
- Defined in index.ts:94

unregisterLookupFunction

unregisterLookupFunction(prefix: string, lookup?: LookupFunction): void
Registers a new lookup callback that can map keys to values, for a given set of keys that share the same prefix.
Parameters
- prefix: string
- Optionallookup: LookupFunction
Returns void
Example
```
// ...
libp2p.services.fetch.unregisterLookupFunction('/prefix')
```
- Defined in index.ts:107