Interface Pins

interface Pins {
    add(cid, options?): AsyncGenerator<CID<unknown, number, number, Version>, void, undefined>;
    get(cid, options?): Promise<Pin>;
    isPinned(cid, options?): Promise<boolean>;
    ls(options?): AsyncGenerator<Pin, void, undefined>;
    rm(cid, options?): AsyncGenerator<CID<unknown, number, number, Version>, void, undefined>;
    setMetadata(cid, metadata, options?): Promise<void>;
}

Methods

add get isPinned ls rm setMetadata

Methods

add

  • add(cid, options?): AsyncGenerator<CID<unknown, number, number, Version>, void, undefined>

  • Pin a block in the blockstore. It will not be deleted when garbage collection is run.

    Parameters

    Returns AsyncGenerator<CID<unknown, number, number, Version>, void, undefined>

get

  • get(cid, options?): Promise<Pin>

  • If the CID is pinned, return details of the pin, otherwise throw an error

    Parameters

    Returns Promise<Pin>

isPinned

  • isPinned(cid, options?): Promise<boolean>

  • Return true if the passed CID is pinned

    Parameters

    Returns Promise<boolean>

ls

  • ls(options?): AsyncGenerator<Pin, void, undefined>

  • List all blocks that have been pinned.

    Parameters

    Returns AsyncGenerator<Pin, void, undefined>

rm

  • rm(cid, options?): AsyncGenerator<CID<unknown, number, number, Version>, void, undefined>

  • Unpin the block that corresponds to the passed CID. The block will be deleted when garbage collection is run.

    Parameters

    Returns AsyncGenerator<CID<unknown, number, number, Version>, void, undefined>

setMetadata

  • setMetadata(cid, metadata, options?): Promise<void>

  • If the CID is pinned, update the metadata associated with the pin, otherwise throw an error

    Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

addgetisPinnedlsrmsetMetadata