External module "helpers"

Index

Type aliases

SimpleCompletedAction

Functions

Type aliases

SimpleCompletedAction

SimpleCompletedAction: function

Describes a simple 'completed' action.

param: The occurred error.
param: The result.

Type declaration

- (err?: any, result?: TResult): void
- Parameters
  - Optional err: any
  - Optional result: TResult
  Returns void

Functions

asBuffer

asBuffer(data: any, encoding?: string): Buffer

- Defined in helpers.ts:46
Returns data as buffer.

Parameters
- data: any
  
  The input data.
- Optional encoding: string
Returns Buffer

The output data.

createSimplePromiseCompletedAction

createSimplePromiseCompletedAction<TResult>(resolve: function, reject?: function): SimpleCompletedAction

- Defined in helpers.ts:72
Creates a simple 'completed' callback for a promise.

Type parameters
- TResult
Parameters
- resolve: function
  
  The 'succeeded' callback.
  - - (value?: TResult | PromiseLike<TResult>): void
    - Parameters
      - Optional value: TResult | PromiseLike<TResult>
      Returns void
- Optional reject: function
  
  The 'error' callback.
  - - (reason: any): void
    - Parameters
      - reason: any
      Returns void
Returns SimpleCompletedAction

The created action.

isEmptyString

isEmptyString(val: any): boolean

- Defined in helpers.ts:96
Checks if the string representation of a value is empty or contains whitespaces only.

Parameters
- val: any
  
  The value to check.
Returns boolean

Is empty or not.

isNullOrUndefined

isNullOrUndefined(val: any): boolean

- Defined in helpers.ts:107
Checks if a value is (null) or (undefined).

Parameters
- val: any
  
  The value to check.
Returns boolean

Is (null)/(undefined) or not.

normalizeString

normalizeString(val: any, normalizer?: function): string

- Defined in helpers.ts:120
Normalizes a value as string so that is comparable.

Parameters
- val: any
  
  The value to convert.
- Optional normalizer: function
  - - (str: string): string
    - Parameters
      - str: string
      Returns string
Returns string

The normalized value.

readSocket

readSocket(socket: Socket, numberOfBytes?: number): Promise<Buffer>

- Defined in helpers.ts:136
Reads a number of bytes from a socket.

Parameters
- socket: Socket
  
  The socket.
- Optional numberOfBytes: number
Returns Promise<Buffer>

The promise.

toBooleanSafe

toBooleanSafe(val: any, defaultValue?: any): boolean

- Defined in helpers.ts:169
Converts a value to a boolean.

Parameters
- val: any
  
  The value to convert.
- Default value defaultValue: any = false
  
  The value to return if 'val' is (null) or (undefined).
Returns boolean

The converted value.

toStringSafe

toStringSafe(str: any, defValue?: any): string

- Defined in helpers.ts:185
Converts a value to a string that is NOT (null) or (undefined).

Parameters
- str: any
  
  The input value.
- Default value defValue: any = ""
  
  The default value.
Returns string

The output value.

Generated using TypeDoc