Class default

Utility class containing various static methods for common operations.

Index

Constructors

Methods

caseInsensitiveObjectForKey cleanTemporaryFolder ddbMarshall ddbUnmarshall isHybridlessContainer isValidNumber isValidString parseIntNullIfNaN parseObjectNullIfEmpty

Constructors

constructor

new default(): default
Returns default

Methods

`Static`caseInsensitiveObjectForKey

caseInsensitiveObjectForKey(obj: any, key: string): any
Retrieves the value from an object using a case-insensitive key lookup.
Parameters
- obj: any
  The object to search for the key.
- key: string
  The key to search for in the object.
Returns any
The value associated with the key, or null if the key is not found.
- Defined in src/Util/Utils.ts:74

`Static`cleanTemporaryFolder

cleanTemporaryFolder(): Promise<void>
Cleans out the /tmp directory asynchronously.

Returns Promise<void>
- Defined in src/Util/Utils.ts:84

`Static`ddbMarshall

ddbMarshall<T>(item: T, rec?: boolean): any
Marshalls the given item into a DynamoDB format. If the item is an array, it maps over each element and marshalls it recursively. If the item is an object, it marshalls the object using the marshall function with options to remove undefined values and convert class instances to maps. If the item is neither an array nor an object, it converts the item to an attribute.
Type Parameters
- T
Parameters
- item: T
  The item to be marshalled.
- Optionalrec: boolean
Returns any
The marshalled item in DynamoDB format.
- Defined in src/Util/Utils.ts:105

`Static`ddbUnmarshall

ddbUnmarshall(item: any): any
Recursively unmarshalls a DynamoDB item by converting it into a plain JavaScript object.
Parameters
- item: any
  The DynamoDB item to unmarshall.
Returns any
The unmarshalled JavaScript object.
- Defined in src/Util/Utils.ts:123

`Static`isHybridlessContainer

isHybridlessContainer(): boolean
Checks if the application is running in a hybridless container.

Returns boolean
- True if the application is running in a hybridless container, false otherwise.
- Defined in src/Util/Utils.ts:13

`Static`isValidNumber

isValidNumber(number: string): boolean
Checks if a given value is a valid number.
Parameters
- number: string
  The value to be checked.
Returns boolean
- True if the value is a valid number, false otherwise.
- Defined in src/Util/Utils.ts:58

`Static`isValidString

isValidString(string: string): boolean
Checks if a given string is valid.
Parameters
- string: string
  The string to check.
Returns boolean
- True if the string is valid, false otherwise.
- Defined in src/Util/Utils.ts:22

`Static`parseIntNullIfNaN

parseIntNullIfNaN(str?: string): null | number
Parses a string into an integer and returns null if the string is not a valid number.
Parameters
- Optionalstr: string
  The string to parse into an integer.
Returns null | number
- The parsed integer or null if the string is not a valid number.
- Defined in src/Util/Utils.ts:31

`Static`parseObjectNullIfEmpty

parseObjectNullIfEmpty(string: undefined | string): any
Parses a JSON string and returns the resulting object. If the string is empty or cannot be parsed, null is returned.
Parameters
- string: undefined | string
  The JSON string to parse.
Returns any
- The parsed object or null if the string is empty or invalid.
- Defined in src/Util/Utils.ts:42