@sakuli/commons

Type aliases

CleanUp

CleanUp: () => void

Type declaration

- (): void
- Returns void

LogConsumerAdapter

LogConsumerAdapter: (logger: SimpleLogger, stringifier?: LogEventStringifier) => CleanUp

Type declaration

- (logger: SimpleLogger, stringifier?: LogEventStringifier): CleanUp
- Parameters
  - logger: SimpleLogger
  - Optional stringifier: LogEventStringifier
  Returns CleanUp

LogEventStringifier

LogEventStringifier: (event: LogEvent) => string

Type declaration

- (event: LogEvent): string
- Parameters
  - event: LogEvent
  Returns string

Maybe

Maybe<T>: T | null | undefined

Type parameters

Reflection

Reflection: (key: string) => string

Type declaration

- (key: string): string
- Parameters
  - key: string
  Returns string

Functions

Const BooleanProperty

BooleanProperty(path: string): (__namedParameters: any, property: string) => void

- Defined in properties/decorator/properties.decorator.ts:61
Converts value to Boolean if present

Parameters
- path: string
Returns (__namedParameters: any, property: string) => void
- - (__namedParameters: any, property: string): void
  - Parameters
    - __namedParameters: any
    - property: string
    Returns void

Const ListProperty

ListProperty(path: string, __namedParameters?: Partial<ListPropertyOptions>): (__namedParameters: any, property: string) => void

- Defined in properties/decorator/properties.decorator.ts:93
Assuming a string string data (all inputs are converted to string).

Parameters
- path: string
- __namedParameters: Partial<ListPropertyOptions> = {}
Returns (__namedParameters: any, property: string) => void
- - (__namedParameters: any, property: string): void
  - Parameters
    - __namedParameters: any
    - property: string
    Returns void

Const NumberProperty

NumberProperty(path: string): (__namedParameters: any, property: string) => void

- Defined in properties/decorator/properties.decorator.ts:69
Converts value to Number if present

Parameters
- path: string
Returns (__namedParameters: any, property: string) => void
- - (__namedParameters: any, property: string): void
  - Parameters
    - __namedParameters: any
    - property: string
    Returns void

Property

Property(path: string, reader?: ReadMap<any, any>): (__namedParameters: any, property: string) => void

- Defined in properties/decorator/properties.decorator.ts:42
Parameters
- path: string
- reader: ReadMap<any, any> = identity
Returns (__namedParameters: any, property: string) => void
- - (__namedParameters: any, property: string): void
  - Parameters
    - __namedParameters: any
    - property: string
    Returns void

Const StringProperty

StringProperty(path: string): (__namedParameters: any, property: string) => void

- Defined in properties/decorator/properties.decorator.ts:77
Converts value to String if present

Parameters
- path: string
Returns (__namedParameters: any, property: string) => void
- - (__namedParameters: any, property: string): void
  - Parameters
    - __namedParameters: any
    - property: string
    Returns void

Const createCiLogConsumer

createCiLogConsumer(): LogConsumerAdapter

- Defined in logger/consumer/create-ci-log-consumer.function.ts:5
Returns LogConsumerAdapter

createClosableWriteStreamConsumer

createClosableWriteStreamConsumer(stream: WritableStream): LogConsumerAdapter

- Defined in logger/consumer/create-closable-write-stream-consumer.function.ts:6
Parameters
- stream: WritableStream
Returns LogConsumerAdapter

Const createCombinedLogConsumer

createCombinedLogConsumer(...consumers: LogConsumerAdapter[]): LogConsumerAdapter

- Defined in logger/consumer/create-combined-log-consumer.function.ts:5
Parameters
- Rest ...consumers: LogConsumerAdapter[]
Returns LogConsumerAdapter

Const createFileLogConsumer

createFileLogConsumer(options: FileLogConsumerOptions): LogConsumerAdapter

- Defined in logger/consumer/create-file-log-consumer.function.ts:11
Parameters
- options: FileLogConsumerOptions
Returns LogConsumerAdapter

createPropertyObjectFactory

createPropertyObjectFactory(propertyMap: PropertyMap): <T>(cls: Type<T>) => T

- Defined in properties/decorator/create-property-object-factory.function.ts:13
Parameters
- propertyMap: PropertyMap
Returns <T>(cls: Type<T>) => T
a mapping function for Constructors of a decorated class which is bound to the propertyMap
- - <T>(cls: Type<T>): T
  - Type parameters
    - T
    Parameters
    - cls: Type<T>
    Returns T

Const defaultStringifier

defaultStringifier(event: LogEvent): string

- Defined in logger/stringifier/default-stringifier.function.ts:20
Parameters
- event: LogEvent
Returns string

ensure

ensure<T>(maybe: Maybe<T>, fallback: T): T

- Defined in maybe.ts:35
Type parameters
- T
Parameters
- maybe: Maybe<T>
- fallback: T
Returns T

ensurePath

ensurePath(path: string): Promise<void>

- Defined in fs/ensure-path.function.ts:3
Parameters
- path: string
Returns Promise<void>

filterAsync

filterAsync<T>(cb: (value: T, index: number, array: T[]) => Promise<boolean>): (data: T[]) => Promise<T[]>

- Defined in async/filter.function.ts:3
Type parameters
- T
Parameters
- cb: (value: T, index: number, array: T[]) => Promise<boolean>
  - - (value: T, index: number, array: T[]): Promise<boolean>
    - Parameters
      - value: T
      - index: number
      - array: T[]
      Returns Promise<boolean>
Returns (data: T[]) => Promise<T[]>
- - (data: T[]): Promise<T[]>
  - Parameters
    - data: T[]
    Returns Promise<T[]>

getPropertyDecoratorDefinitions

getPropertyDecoratorDefinitions(type: Type<any>): PropertyDecoratorDefinition[]

- Defined in properties/decorator/properties.decorator.ts:109
Parameters
- type: Type<any>
Returns PropertyDecoratorDefinition[]

ifPresent

ifPresent<T>(maybe: Maybe<T>, then: (v: T) => void): void
ifPresent<T, R>(maybe: Maybe<T>, then: (v: T) => R, otherwise: () => R): R

- Defined in maybe.ts:11
Type parameters
- T
Parameters
- maybe: Maybe<T>
- then: (v: T) => void
  - - (v: T): void
    - Parameters
      - v: T
      Returns void
Returns void
- Defined in maybe.ts:12
Type parameters
- T
- R = void
Parameters
- maybe: Maybe<T>
- then: (v: T) => R
  - - (v: T): R
    - Parameters
      - v: T
      Returns R
- otherwise: () => R
  - - (): R
    - Returns R
Returns R

invokeIfPresent

invokeIfPresent<ARGS, R>(maybeFn: Maybe<(...args: ARGS) => R>, ...args: ARGS): Maybe<R>

- Defined in invoke-if-present.function.ts:4
Type parameters
- ARGS: any[]
- R
Parameters
- maybeFn: Maybe<(...args: ARGS) => R>
- Rest ...args: ARGS
Returns Maybe<R>

isPresent

isPresent<T>(maybe: Maybe<T>): maybe is T

- Defined in maybe.ts:3
Type parameters
- T
Parameters
- maybe: Maybe<T>
Returns maybe is T

mapAsync

mapAsync<T, U>(callbackfn: (value: T, index: number, array: T[]) => Promise<U>): (data: T[]) => Promise<U[]>

- Defined in async/map.function.ts:1
Type parameters
- T
- U
Parameters
- callbackfn: (value: T, index: number, array: T[]) => Promise<U>
  - - (value: T, index: number, array: T[]): Promise<U>
    - Parameters
      - value: T
      - index: number
      - array: T[]
      Returns Promise<U>
Returns (data: T[]) => Promise<U[]>
- - (data: T[]): Promise<U[]>
  - Parameters
    - data: T[]
    Returns Promise<U[]>

Const objectReflection

objectReflection(v: object, separator?: string): Reflection

- Defined in templates/object-reflection.function.ts:16
Utility function for more declarative use of template function
const tpl = template("..."); const rendered = tpl(objectReflection({ }));
Parameters
- v: object
- separator: string = "."
Returns Reflection

Const template

template(t: string, interpolation?: RegExp): (dataReflection: (key: string) => string) => string

- Defined in templates/template.function.ts:14
Parameters
- t: string
- interpolation: RegExp = ...
Returns (dataReflection: (key: string) => string) => string
- - (dataReflection: (key: string) => string): string
  - Parameters
    - dataReflection: (key: string) => string
      - (key: string): string
        Parameters
        key: string
        Returns string
    Returns string

throwIfAbsent

throwIfAbsent<T>(maybe: Maybe<T>, error?: Error): T | never

- Defined in maybe.ts:43
Type parameters
- T
Parameters
- maybe: Maybe<T>
- error: Error = ...
Returns T | never

Const throwOnRuntimeTypeMissmatch

throwOnRuntimeTypeMissmatch(value: any, type: "Undefined" | "Object" | "Boolean" | "Number" | "BigInt" | "String" | "Symbol" | "Function", message: string): void

- Defined in runtime-typecheck.function.ts:20
This function is useful for runtime typechecking

Since the JS runtime does not care about types, it is possible for users to e.g. initialize objects in a wrong way, causing errors during execution. TypeScript can't help us here, so we have to provide our own typeguards during runtime.

The reason why this function is implemented the way it is implemented and not just uses e.g. typeof arg === 'string' is the fact that typeof will not handle everything as expected. It's valid, although not common, to pass a new String("foo") object instead of just "foo" to a function, in which case typeof would return 'object' instead of 'string'.

The typeRegex used test the output of Object.prototype.toString, which would be [object String] in both cases (new String("foo") and "foo") So no matter whether a user passes a string literal or a String object, the typecheck will handle both cases.

Parameters
- value: any
  
  The value to typecheck
- type: "Undefined" | "Object" | "Boolean" | "Number" | "BigInt" | "String" | "Symbol" | "Function"
  
  The expected runtime type, one of "Undefined" | "Object" | "Boolean" | "Number" | "BigInt" | "String" | "Symbol" | "Function"
- message: string
  
  The TypeError message in case of a runtime type missmatch
Returns void

Index

Enumerations

Classes

Interfaces

Type aliases

Functions

Type aliases

CleanUp

Type declaration

Returns void

LogConsumerAdapter

Type declaration

Parameters

logger: SimpleLogger

Optional stringifier: LogEventStringifier

Returns CleanUp

LogEventStringifier

Type declaration

Parameters

event: LogEvent

Returns string

Maybe

Type parameters

T

Reflection

Type declaration

Parameters

key: string

Returns string

Functions

Const BooleanProperty

Parameters

path: string

Returns (__namedParameters: any, property: string) => void

Parameters

__namedParameters: any

property: string

Returns void

Const ListProperty

Parameters

path: string

__namedParameters: Partial<ListPropertyOptions> = {}

Returns (__namedParameters: any, property: string) => void

Parameters

__namedParameters: any

property: string

Returns void

Const NumberProperty

Parameters

path: string

Returns (__namedParameters: any, property: string) => void

Parameters

__namedParameters: any

property: string

Returns void

Property

Parameters

path: string

reader: ReadMap<any, any> = identity

Returns (__namedParameters: any, property: string) => void

Parameters

__namedParameters: any

property: string

Returns void

Const StringProperty

Parameters

path: string

Returns (__namedParameters: any, property: string) => void

Parameters

__namedParameters: any

property: string

Returns void

Const createCiLogConsumer

Returns LogConsumerAdapter

createClosableWriteStreamConsumer

Parameters

stream: WritableStream

Returns LogConsumerAdapter

Const createCombinedLogConsumer

Parameters