Class API

constructor

• new API(client): IPFS.v1alpha1.API

• Parameters

  • client: Client

  Returns IPFS.v1alpha1.API

Static ReadonlyLOCALITIES

createPinByCID

• createPinByCID(request): Promise<Pin>

• Create a pin by CID. Will fetch and store the content pointed by the provided CID. The content must be available on the public IPFS network. The content (IPFS blocks) will be host by the pinning service until pin deletion. From that point, any other IPFS peer can fetch and host your content: Make sure to pin public or encrypted content. Many pin requests (from different users) can target the same CID. A pin is defined by its ID (UUID), its status (queued, pinning, pinned or failed) and target CID.

  Parameters

  • request: Readonly<CreatePinByCIDRequest>

    The request CreatePinByCIDRequest

  Returns Promise<Pin>

  A Promise of Pin

createPinByURL

• createPinByURL(request): Promise<Pin>

• Create a pin by URL. Will fetch and store the content pointed by the provided URL. The content must be available on the public IPFS network. The content (IPFS blocks) will be host by the pinning service until pin deletion. From that point, any other IPFS peer can fetch and host your content: Make sure to pin public or encrypted content. Many pin requests (from different users) can target the same CID. A pin is defined by its ID (UUID), its status (queued, pinning, pinned or failed) and target CID.

  Parameters

  • request: Readonly<CreatePinByURLRequest>

    The request CreatePinByURLRequest

  Returns Promise<Pin>

  A Promise of Pin

createVolume

• createVolume(request): Promise<IPFS.v1alpha1.Volume>

• Create a new volume. Create a new volume from a Project ID. Volume is identified by an ID and used to host pin references. Volume is personal (at least to your organization) even if IPFS blocks and CID are available to anyone. Should be the first command you made because every pin must be attached to a volume.

  Parameters

  • request: Readonly<IPFS.v1alpha1.CreateVolumeRequest>

    The request CreateVolumeRequest

  Returns Promise<IPFS.v1alpha1.Volume>

  A Promise of Volume

deletePin

• deletePin(request): Promise<void>

• Create an unpin request. An unpin request means that you no longer own the content. This content can therefore be removed and no longer provided on the IPFS network.

  Parameters

  • request: Readonly<DeletePinRequest>

    The request DeletePinRequest

  Returns Promise<void>

deleteVolume

• deleteVolume(request): Promise<void>

• Delete an existing volume. Delete a volume by its ID and every pin attached to this volume. This process can take a while to conclude, depending on the size of your pinned content.

  Parameters

  • request: Readonly<IPFS.v1alpha1.DeleteVolumeRequest>

    The request DeleteVolumeRequest

  Returns Promise<void>

getPin

• getPin(request): Promise<Pin>

• Get pin information. Retrieve information about the provided pin ID, such as status, last modification, and CID.

  Parameters

  • request: Readonly<GetPinRequest>

    The request GetPinRequest

  Returns Promise<Pin>

  A Promise of Pin

getVolume

• getVolume(request): Promise<IPFS.v1alpha1.Volume>

• Get information about a volume. Retrieve information about a specific volume.

  Parameters

  • request: Readonly<IPFS.v1alpha1.GetVolumeRequest>

    The request GetVolumeRequest

  Returns Promise<IPFS.v1alpha1.Volume>

  A Promise of Volume

listPins

• listPins(request): Promise<ListPinsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Pin[], void, void>);
      all: (() => Promise<Pin[]>);
  }

• List all pins within a volume. Retrieve information about all pins within a volume.

  Parameters

  • request: Readonly<ListPinsRequest>

    The request ListPinsRequest

  Returns Promise<ListPinsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Pin[], void, void>);
      all: (() => Promise<Pin[]>);
  }

  A Promise of ListPinsResponse

listVolumes

• listVolumes(request?): Promise<IPFS.v1alpha1.ListVolumesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<IPFS.v1alpha1.Volume[], void, void>);
      all: (() => Promise<IPFS.v1alpha1.Volume[]>);
  }

• List all volumes by a Project ID. Retrieve information about all volumes from a Project ID.

  Parameters

  • request: Readonly<IPFS.v1alpha1.ListVolumesRequest> = {}

    The request ListVolumesRequest

  Returns Promise<IPFS.v1alpha1.ListVolumesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<IPFS.v1alpha1.Volume[], void, void>);
      all: (() => Promise<IPFS.v1alpha1.Volume[]>);
  }

  A Promise of ListVolumesResponse

replacePin

• replacePin(request): Promise<ReplacePinResponse>

• Replace pin by CID. Deletes the given resource ID and pins the new CID in its place. Will fetch and store the content pointed by the provided CID. The content must be available on the public IPFS network. The content (IPFS blocks) is hosted by the pinning service until the pin is deleted. While the content is available any other IPFS peer can fetch and host your content. For this reason, we recommend that you pin either public or encrypted content. Several different pin requests can target the same CID. A pin is defined by its ID (UUID), its status (queued, pinning, pinned or failed) and target CID.

  Parameters

  • request: Readonly<ReplacePinRequest>

    The request ReplacePinRequest

  Returns Promise<ReplacePinResponse>

  A Promise of ReplacePinResponse

updateVolume

• updateVolume(request): Promise<IPFS.v1alpha1.Volume>

• Update volume information. Update volume information (tag, name...).

  Parameters

  • request: Readonly<IPFS.v1alpha1.UpdateVolumeRequest>

    The request UpdateVolumeRequest

  Returns Promise<IPFS.v1alpha1.Volume>

  A Promise of Volume

waitForPin

• waitForPin(request, options?): Promise<Pin>

• Waits for Pin to be in a final state.

  Parameters

  • request: Readonly<GetPinRequest>

    The request GetPinRequest
  • Optionaloptions: Readonly<WaitForOptions<Pin>>

    The waiting options

  Returns Promise<Pin>

  A Promise of Pin