Module util

General utilities

Index

Functions

Functions

Const Throw

Throw(e: string | Error): never

- Defined in src/util.ts:14
like 'throw', but a function rather than a statement.

Parameters
- e: string | Error
  
  The exception or string to be thrown.
Returns never

Const asFiles

asFiles(t?: Files | Tree): null | Files

- Defined in src/util.ts:41
A type checker that verifies the argument is a file array, not a directory tree. Throws an error if given something else

Parameters
- Optional t: Files | Tree
  
  A tree or a file array
Returns null | Files

A file array or null if the argument was undefined

Const asTree

asTree(t?: Files | Tree): null | Tree

- Defined in src/util.ts:54
A type checker that verifies the argument is a tree, not a file array. Throws an error if given something else.

Parameters
- Optional t: Files | Tree
  
  A tree or a file array
Returns null | Tree

Tree or null if the argument was undefined.

Const deleteVersion

deleteVersion(files: Files, version: Version): void

- Defined in src/util.ts:162
Delete a specific version from a Files array. This is an internal tool for implementing FILE handlers

Parameters
- files: Files
  
  The Files array
- version: Version
  
  The version to delete. Either a version number or a label. The special label '*' deletes all versions.
Returns void

void

Const encodeString

encodeString(s: string): ArrayBuffer

- Defined in src/util.ts:190
Encode a string into an ArrayBuffer.

Parameters
- s: string
  
  The string to be encoded
Returns ArrayBuffer

An ArrayBuffer with the string data as UTF-16

Const getVersion

getVersion(files: Files, version: Version): null | VFile

- Defined in src/util.ts:124
Add a file at a specific version or label in a Files array. This is an internal tool for implementing FILE handlers.

Parameters
- files: Files
  
  The Files array
- version: Version
  
  The version to delete. Either a version number or a label
Returns null | VFile

void

Const isFileAttachment

isFileAttachment(a: any): a is FileAttachment

- Defined in src/util.ts:68
A type guard that determines if the argument is a FileAttachment

Parameters
- a: any
  
  A FileAttachment or AFile
Returns a is FileAttachment

true if argument is a FileAttachment

Const isFiles

isFiles(t?: Files | Tree): t is Files

- Defined in src/util.ts:26
A type guard to distinguish directory trees and file arrays.

Parameters
- Optional t: Files | Tree
  
  The object, which should be a directory tree or a files array
Returns t is Files

true if the argument is a Files array

Const isTree

isTree(t?: Files | Tree): t is Tree

- Defined in src/util.ts:33
A type guard to distinguish directory trees and file arrays.

Parameters
- Optional t: Files | Tree
  
  The object, which should be a directory tree or a files array
Returns t is Tree

true if the argument is a Tree

Const meta

meta<T>(obj: T, metadata: Metadata): any

- Defined in src/util.ts:205
Associate a metadata object with the specified file (or array of file versions). This is normally used to annotate entries in the FileAttachment tree.

Type parameters
- T
Parameters
- obj: T
- metadata: Metadata
Returns any

Const setVersion

setVersion(files: Files, version: Version, newFile: VFile): void

- Defined in src/util.ts:141
Add a file at a specific version or label in a Files array. This is an internal tool for implementing FILE handlers.

Parameters
- files: Files
  
  The Files array
- version: Version
  
  The version to set. Either a version number or a label
- newFile: VFile
  
  The FileAttachment or AFile
Returns void

void

Generated using TypeDoc