Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes Ceramic pinning functionality

Hierarchy

  • PinApi

Index

Methods

Methods

add

  • add(streamId: StreamID, force?: boolean): Promise<void>
  • Pin stream

    Parameters

    • streamId: StreamID

      Stream ID

    • Optional force: boolean

      If true, re-pins all stream content even if the node already believes the stream

      • to be pinned.

    Returns Promise<void>

ls

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

rm

  • rm(streamId: StreamID, opts?: PublishOpts): Promise<void>
  • Unpin stream

    Parameters

    • streamId: StreamID

      Stream ID

    • Optional opts: PublishOpts

      can be set to make the node publish the stream's current tip before unpinning it, giving other nodes on the network one last chance to capture the stream's current state before this node forgets about it.

    Returns Promise<void>