Type aliases
AddResult
Add
Result: { cid: CID; isFile: boolean; size: number }
Type declaration
-
-
isFile: boolean
-
size: number
CIDObj
CIDObj
: { codec
: Codec; multibaseName
: MultibaseName; version
: number; toString
: any; toV1
: any }
Type declaration
-
-
-
version: number
-
toString: function
-
toV1: function
DAGLink
DAGLink
: { Hash
: CIDObj; Name
: string; Tsize
: number }
Type declaration
-
-
Name: string
-
Tsize: number
DAGNode
DAGNode
: { Links
: DAGLink[]; addLink
: (link
: DAGLink) => void; rmLink
: (name
: string) => void; size
: number; toDAGLink
: (opt
?: { name
?: string }) => Promise<DAGLink>; toJSON
: () => Record<string, unknown> }
Type declaration
-
-
addLink: (link: DAGLink) => void
-
rmLink: (name: string) => void
-
size: number
-
toDAGLink: (opt?: { name?: string }) => Promise<DAGLink>
-
- (opt?: { name?: string }): Promise<DAGLink>
-
Parameters
-
Optional opt: { name?: string }
Returns Promise<DAGLink>
-
toJSON: () => Record<string, unknown>
-
- (): Record<string, unknown>
-
Returns Record<string, unknown>
FileContent
FileContent: Record<string, unknown> | Buffer | Blob | string | number | boolean
FileContentRaw
FileContentRaw: Buffer
FileMode
FileMode: number
IPFS
Type declaration
-
-
-
-
-
-
add: function
-
Parameters
-
-
Optional options: unknown
-
cat: function
- cat(cid: string): AsyncIterable<Buffer>
-
Parameters
Returns AsyncIterable<Buffer>
-
dns: function
- dns(domain: string): Promise<string>
-
Parameters
Returns Promise<string>
-
ls: function
MultibaseName
MultibaseName: string
ObjStat
ObjStat: { BlockSize: number; CumulativeSize: number; DataSize: number; Hash: string; LinksSize: number; NumLinks: number }
Type declaration
-
BlockSize: number
-
CumulativeSize: number
-
DataSize: number
-
Hash: string
-
LinksSize: number
-
NumLinks: number
RawDAGLink
RawDAGLink
: { Hash
: CIDObj; Name
: string; Tsize
: number }
Type declaration
-
-
Name: string
-
Tsize: number
RawDAGNode
RawDAGNode
: { remainderPath
: string; value
: { Data
: Uint8Array; Links
: RawDAGLink[]; _serializedSize
: number; _size
: number } }
Type declaration
-
remainderPath: string
-
value: { Data: Uint8Array; Links: RawDAGLink[]; _serializedSize: number; _size: number }
-
Data: Uint8Array
-
-
_serializedSize: number
-
_size: number
SwarmAPI
SwarmAPI: { connect: (address: string) => Promise<unknown> }
Type declaration
-
connect: (address: string) => Promise<unknown>
-
- (address: string): Promise<unknown>
-
Parameters
Returns Promise<unknown>
UnixFSFile
UnixFSFile
: { cid
: CIDObj; mode
?: FileMode; mtime
?: number; name
?: string; path
: string; size
: number; type
?: string }
Type declaration
-
-
-
Optional mtime?: number
-
Optional name?: string
-
path: string
-
size: number
-
Optional type?: string