Class export=

constructor

• new "export="(): export=

  Returns export=

Static ReadonlyRATIO_FLOOR_BYTES

Staticallowance

• allowance(stored: number, limits: ExpandLimits): number

  Returns how many expanded bytes a file of stored bytes may become: the ratio times its size, at least the floor, at most the cap.

  Parameters

  • stored: number

    the file's size

  • limits: ExpandLimits

    the limits

  Returns number

  the allowance in bytes

StaticheadOf

• headOf(file: string): Buffer

  Reads the first bytes of a file, for sniff().

  Parameters

  • file: string

    the file's path

  Returns Buffer

  the bytes

Staticlimits

• limits(): ExpandLimits

  Returns the expansion limits as the settings say now.

  Returns ExpandLimits

  the limits

Staticopen

• open(file: string, given?: ExpandLimits): Promise<Opened>

  Opens a file for reading, expanded if it is compressed.

  The stream fails with a coded error on a bomb (STS-RISK-0032), an ambiguous archive (STS-RISK-0033) or a corrupt file (STS-RISK-0034).

  Parameters

  • file: string

    the file's path

  • Optionalgiven: ExpandLimits

    the limits; the settings' when omitted

  Returns Promise<Opened>

  { kind, entry, stream, close }, where close() releases the file however reading ended and is safe to call twice

StaticreadText

• readText(file: string, maxChars: number, given?: ExpandLimits): Promise<string>

  Reads a whole file as text, expanded: the FIDO MDS3 BLOB, which is one signed document rather than lines.

  Parameters

  • file: string

    the file's path

  • maxChars: number

    the most characters held; past it the read is refused

  • Optionalgiven: ExpandLimits

    the limits; the settings' when omitted

  Returns Promise<string>

  the text

Staticsniff

• sniff(head: Buffer): "plain" | "gzip" | "zip"

  Says what a file's first bytes say it is.

  Parameters

  • head: Buffer

    the file's first bytes

  Returns "plain" | "gzip" | "zip"

  gzip, zip or plain