Class UnixFS

constructor

• new UnixFS(options?): UnixFS

• Parameters

  • options: UnixFSOptions = ...

  Returns UnixFS

blockSizes

Optional data

Optional fanout

Optional hashType

Optional mtime

type

mode

• get mode(): undefined | number

• Returns undefined | number

• set mode(mode): void

• Parameters

  • mode: undefined | number

  Returns void

addBlockSize

• addBlockSize(size): void

• Parameters

  • size: bigint

  Returns void

fileSize

• fileSize(): bigint

• Returns 0n for directories or data.length + sum(blockSizes) for everything else

  Returns bigint

isDirectory

• isDirectory(): boolean

• Returns boolean

marshal

• marshal(): Uint8Array

• encode to protobuf Uint8Array

  Returns Uint8Array

removeBlockSize

• removeBlockSize(index): void

• Parameters

  • index: number

  Returns void

Static unmarshal

• unmarshal(marshaled): UnixFS

• Decode from protobuf https://github.com/ipfs/specs/blob/master/UNIXFS.md

  Parameters

  • marshaled: Uint8Array

  Returns UnixFS