Class UnixFS

constructor

• new UnixFS(options?: UnixFSOptions): UnixFS

  Parameters

  • options: UnixFSOptions = ...

  Returns UnixFS

blockSizes

Optionaldata

Optionalfanout

OptionalhashType

Optionalmtime

type

mode

• get mode(): undefined | number

  Returns undefined | number

• set mode(mode: undefined | number): void

  Parameters

  • mode: undefined | number

  Returns void

addBlockSize

• addBlockSize(size: bigint): 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: number): void

  Parameters

  • index: number

  Returns void

Staticunmarshal

• unmarshal(marshaled: Uint8Array): UnixFS

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

  Parameters

  • marshaled: Uint8Array

  Returns UnixFS