Interface ContentRouting

interface ContentRouting {
    cancelReprovide(key: CID, options?: RoutingOptions): Promise<void>;
    findProviders(cid: CID, options?: RoutingOptions): AsyncIterable<Provider>;
    get(
        key: Uint8Array,
        options?: RoutingOptions,
    ): Promise<Uint8Array<ArrayBufferLike>>;
    provide(cid: CID, options?: RoutingOptions): Promise<void>;
    put(
        key: Uint8Array,
        value: Uint8Array,
        options?: RoutingOptions,
    ): Promise<void>;
}

Index

Methods

cancelReprovide findProviders get provide put

Methods

cancelReprovide

cancelReprovide(key: CID, options?: RoutingOptions): Promise<void>
If network peers need to be periodically reminded that the caller can provide content corresponding to the passed CID, call this function to no longer remind them.
Parameters
- key: CID
- Optionaloptions: RoutingOptions
Returns Promise<void>
- Defined in packages/interface/src/content-routing.ts:60

findProviders

findProviders(cid: CID, options?: RoutingOptions): AsyncIterable<Provider>
Find the providers of the passed CID.
Parameters
- cid: CID
- Optionaloptions: RoutingOptions
Returns AsyncIterable<Provider>
Example
```
// Iterate over the providers found for the given cid
for await (const provider of contentRouting.findProviders(cid)) {
 console.log(provider.id, provider.multiaddrs)
}
```
- Defined in packages/interface/src/content-routing.ts:74

get

get(
key: Uint8Array,
options?: RoutingOptions,
): Promise<Uint8Array<ArrayBufferLike>>
Retrieves a value from the network corresponding to the passed key.
Parameters
- key: Uint8Array
- Optionaloptions: RoutingOptions
Returns Promise<Uint8Array<ArrayBufferLike>>
Example
```
// ...

const key = '/key'
const value = await contentRouting.get(key)
```
- Defined in packages/interface/src/content-routing.ts:104

provide

provide(cid: CID, options?: RoutingOptions): Promise<void>
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
- Optionaloptions: RoutingOptions
Returns Promise<void>
Example
```
// ...
await contentRouting.provide(cid)
```
- Defined in packages/interface/src/content-routing.ts:53

put

put(key: Uint8Array, value: Uint8Array, options?: RoutingOptions): Promise<void>
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
- value: Uint8Array
- Optionaloptions: RoutingOptions
Returns Promise<void>
Example
```
// ...
const key = '/key'
const value = uint8ArrayFromString('oh hello there')

await contentRouting.put(key, value)
```
- Defined in packages/interface/src/content-routing.ts:90