Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ipfs

Index

Namespaces

Type aliases

Variables

Functions

Type aliases

AddResult

AddResult: { cid: CID; isFile: boolean; size: number }

Type declaration

  • cid: CID
  • isFile: boolean
  • size: number

CID

CID: string

Codec

Codec: string

FileContent

FileContent: Record<string, unknown> | FileContentRaw | Blob | string | number | boolean

FileContentRaw

FileContentRaw: Uint8Array

Variables

Const DAG_NODE_DATA

DAG_NODE_DATA: Buffer = ...

Functions

Const add

  • add(content: ImportCandidate): Promise<AddResult>

Const attemptPin

  • attemptPin(cid: string): Promise<void>

Const cat

  • cat(cid: string): Promise<string>

Const catBuf

  • catBuf(cid: string): Promise<Uint8Array>

  • Parameters

    • cid: string

    Returns Promise<Uint8Array>

Const catRaw

  • catRaw(cid: string): Promise<Uint8Array[]>

  • Parameters

    • cid: string

    Returns Promise<Uint8Array[]>

Const dagGet

  • dagGet(cid: string): Promise<DAGNode>

Const dagPut

Const dagPutLinks

  • dagPutLinks(links: DAGLink[]): Promise<AddResult>

Const get

  • get(): Promise<IPFS>

iframe

  • iframe(): Promise<MessagePort>

Const ls

  • ls(cid: string): Promise<IPFSEntry[]>

  • Parameters

    • cid: string

    Returns Promise<IPFSEntry[]>

Const set

  • set(userIpfs: unknown): void

Const size

  • size(cid: string): Promise<number>

Generated using TypeDoc