Overview

This page will cover the helpers, what they do and how to use them.

• Utils
  • normalise
  • resolve
  • getThreadFileFromArgs
  • isJson
  • isConvertable
  • getFilePath

Utils

The utils (utilities) helper just contains a variety of functions, noted below.

normalise

The normalise function is used to normalise a path, it will remove any trailing slashes and ensure that the path is a string.

Parameters

• path - The path to normalise.

normalise(path: string): string

Usage

import { Utils } from '@sodacore/core';

const path = Utils.normalise('\\path\\to\\something\\');
console.log(path); // /path/to/something

resolve

The resolve function is used to resolve a path, it will resolve the path to the current file, and then join it with the path provided.

Parameters

• base - The starting path.
• paths - The paths to join and normalise.

resolve(base: string, ...paths: string[]): string

Usage

import { Utils } from '@sodacore/core';

const path = Utils.resolve('/hello', 'world/../foo');
console.log(path); // /hello/foo

getThreadFileFromArgs

The getThreadFileFromArgs function is used to get the thread file from the arguments passed to the thread, this is called by the thread wrapper.

Parameters

getThreadFileFromArgs(): string

Usage

import { Utils } from '@sodacore/core';

const path = Utils.getThreadFileFromArgs();
console.log(path); // /path/to/thread/file

isJson

The isJson function is used to check if a string is a valid JSON string.

Parameters

• str - The string to check.

isJson(str: string): boolean

Usage

import { Utils } from '@sodacore/core';

const isJson = Utils.isJson('{"hello": "world"}');
console.log(isJson); // true

isConvertable

The isConvertable function is used to check if an object is serialisable.

Parameters

• value - The value to check.

isConvertable(value: any): boolean

Usage

import { Utils } from '@sodacore/core';

const isConvertable = Utils.isConvertable({ hello: 'world' });
console.log(isConvertable); // true

getFilePath

The getFilePath function is used to get the file path, resolving based on the NODE_ENV status, i.e. is it from the src or dist folder.

Parameters

• path - The path to resolve.

getFilePath(path: string): string

Usage

import { Utils } from '@sodacore/core';

const path = Utils.getFilePath('../worker/example.ts');
console.log(path); // /path/to/worker/example.ts