Interface ContentRouting

Hierarchy

ContentRouting

Index

Properties

findProviders get provide put

Properties

findProviders

findProviders: ((cid: CID<unknown, number, number, Version>, options?: AbortOptions) => AsyncIterable<PeerInfo>)

Type declaration

- (cid: CID<unknown, number, number, Version>, options?: AbortOptions): AsyncIterable<PeerInfo>
- Find the providers of the passed CID.
  
  Example
```
// Iterate over the providers found for the given cid
for await (const provider of contentRouting.findProviders(cid)) {
 console.log(provider.id, provider.multiaddrs)
}
```
  Parameters
  - cid: CID<unknown, number, number, Version>
  - Optional options: AbortOptions
  Returns AsyncIterable<PeerInfo>

get

get: ((key: Uint8Array, options?: AbortOptions) => Promise<Uint8Array>)

Type declaration

- (key: Uint8Array, options?: AbortOptions): Promise<Uint8Array>
- Retrieves a value from the network corresponding to the passed key.
  
  Example
```
// ...

const key = '/key'
const value = await contentRouting.get(key)
```
  Parameters
  - key: Uint8Array
  - Optional options: AbortOptions
  Returns Promise<Uint8Array>

provide

provide: ((cid: CID<unknown, number, number, Version>, options?: AbortOptions) => Promise<void>)

Type declaration

- (cid: CID<unknown, number, number, Version>, options?: AbortOptions): Promise<void>
- The implementation of this method should ensure that network peers know the caller can provide content that corresponds to the passed CID.
  
  Example
```
// ...
await contentRouting.provide(cid)
```
  Parameters
  - cid: CID<unknown, number, number, Version>
  - Optional options: AbortOptions
  Returns Promise<void>

put

put: ((key: Uint8Array, value: Uint8Array, options?: AbortOptions) => Promise<void>)

Type declaration

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

await contentRouting.put(key, value)
```
  Parameters
  - key: Uint8Array
  - value: Uint8Array
  - Optional options: AbortOptions
  Returns Promise<void>