Skip to main content

Utils

Helper functions that do not belong to any category in particular.

Functions

diff()

function diff(string1, string2): void

Defined in: functions/utils.ts:14

Helper function to print the differences between two strings. Similar to the diff Unix program.

Parameters

ParameterType
string1string
string2string

Returns

void


fatalError()

function fatalError(...args): never

Defined in: functions/utils.ts:30

Helper function to print out an error message and then exit the program.

All of the arguments will be passed to the console.error function.

Parameters

ParameterType
...argsreadonly unknown[]

Returns

never


getArgs()

function getArgs(): readonly string[]

Defined in: functions/utils.ts:40

Helper function to get the command-line arguments passed to the program/script.

This is an alias for: process.argv.slice(2)

Returns

readonly string[]


isMain()

function isMain(): boolean

Defined in: functions/utils.ts:50

Helper function to see if the current file is is the JavaScript/TypeScript entry point. Returns false if the current file was imported from somewhere else.

This is similar to the __name__ == "__main__" pattern from the Python programming language.

Returns

boolean