Interface PinApi

Describes Ceramic pinning functionality

Hierarchy

PinApi

Index

Methods

Methods

add

add(streamId: StreamID): Promise<void>

- Defined in packages/common/src/ceramic-api.ts:19
Pin stream

Parameters
- streamId: StreamID
  
  Stream ID
Returns Promise<void>

ls

ls(streamId?: StreamID): Promise<AsyncIterable<string>>

- Defined in packages/common/src/ceramic-api.ts:31
List pinned streams

Parameters
- Optional streamId: StreamID
  
  Stream ID for filtering
Returns Promise<AsyncIterable<string>>

rm

rm(streamId: StreamID): Promise<void>

- Defined in packages/common/src/ceramic-api.ts:25
Unpin stream

Parameters
- streamId: StreamID
  
  Stream ID
Returns Promise<void>