Interface PinApi

Describes Ceramic pinning functionality

Hierarchy

PinApi

Index

Methods

Methods

add

add(docId: DocID): Promise<void>

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

Parameters
- docId: DocID
  
  Document ID
Returns Promise<void>

ls

ls(docId?: DocID): Promise<AsyncIterable<string>>

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

Parameters
- Optional docId: DocID
  
  Document ID for filtering
Returns Promise<AsyncIterable<string>>

rm

rm(docId: DocID): Promise<void>

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

Parameters
- docId: DocID
  
  Document ID
Returns Promise<void>