@ircam/sc-utils

@ircam/sc-utils

Simple generic utilities (type check, common math functions, etc.)

Install

npm install --save @ircam/sc-utils

API

Constants

isBrowser ⇒ boolean

Check if the platform is a browser or a node process

Functions

delay(ms) ⇒ Promise

Waits for given number of milliseconds

sleep(sec) ⇒ Promise

Same of delay, but given argument is in seconds

isString(val) ⇒ boolean

Check if the value is a string

isFunction(val) ⇒ boolean

Check if the value is a function

isNumber(val) ⇒ boolean

Check if the value is a number, including Infinity. If you want to excluse Infinity, check the native Number.isFinite function

isPlainObject(val) ⇒ boolean

Check if the value is a Plain Old Javascript Object (POJO)

isTypedArray(val) ⇒ boolean

Check if the value is a TypedArray

dbtoa(val) ⇒ number

Convert a dB into linear gain (i.e. gain) Alias: decibelToLinear

decibelToLinear(val) ⇒ number

Convert a dB into linear gain (i.e. gain) Alis: dbtoa

decibelToPower(val) ⇒ number

Convert a dB into power gain

atodb(val) ⇒ number

Convert a linear gain into dB Alias: linearToDecibel

linearToDecibel(val) ⇒ number

Convert a linear gain into dB Alias: atodb

powerToDecibel(val) ⇒ number

Convert a linear gain into dB

mtof(midiNote) ⇒ number

Convert a MIDI note to frequency

ftom(freq) ⇒ number

Convert a frequency to a MIDI note

linearScale(minIn, maxIn, minOut, maxOut, [clamp]) ⇒ function

Create a scale function

idGenerator() ⇒ Iterator

Create a iterator of incrementing ids

isBrowser ⇒ boolean

Check if the platform is a browser or a node process

Kind: global constant
Example

import { isBrowser } from '@ircam/sc-utils';
isBrowser();
// > true|false

delay(ms) ⇒ Promise

Waits for given number of milliseconds

Kind: global function

Param	Type	Description
ms	Number	Number of milliseconds to wait

Example

import { delay } from '@ircam/sc-utils';
// wait for 1 second
await delay(1000);

sleep(sec) ⇒ Promise

Same of delay, but given argument is in seconds

Kind: global function

Param	Type	Description
sec	Number	Number of seconds to wait

Example

import { sleep } from '@ircam/sc-utils';
// wait for 1 second
await sleep(1);

isString(val) ⇒ boolean

Check if the value is a string

Kind: global function

Param	Type	Description
val	*	Value to check

Example

import { isString } from '@ircam/sc-utils';
isString('test');
// > true

isFunction(val) ⇒ boolean

Check if the value is a function

Kind: global function

Param	Type	Description
val	*	Value to check

Example

import { isFunction } from '@ircam/sc-utils';
isFunction(() => {}));
// > true

isNumber(val) ⇒ boolean

Check if the value is a number, including Infinity. If you want to excluse Infinity, check the native Number.isFinite function

Kind: global function

Param	Type	Description
val	*	Value to check

Example

import { isNumber } from '@ircam/sc-utils';
isNumber(42);
// > true

isPlainObject(val) ⇒ boolean

Check if the value is a Plain Old Javascript Object (POJO)

Kind: global function

Param	Type	Description
val	*	Value to check

Example

import { isObject } from '@ircam/sc-utils';
isObject({ a: 1 });
// > true

isTypedArray(val) ⇒ boolean

Check if the value is a TypedArray

Kind: global function

Param	Type	Description
val	*	Value to check

Example

import { isTypedArray } from '@ircam/sc-utils';
isTypedArray(new Float32Array([1, 2, 3]));
// > true

dbtoa(val) ⇒ number

Convert a dB into linear gain (i.e. gain) Alias: decibelToLinear

Kind: global function

Param	Type	Description
val	number	Value to convert

Example

import { dbtoa } from '@ircam/sc-utils';
dbtoa(0);
// > 1

decibelToLinear(val) ⇒ number

Convert a dB into linear gain (i.e. gain) Alis: dbtoa

Kind: global function

Param	Type	Description
val	number	Value to convert

Example

import { decibelToLinear } from '@ircam/sc-utils';
decibelToLinear(0);
// > 1

decibelToPower(val) ⇒ number

Convert a dB into power gain

Kind: global function

Param	Type	Description
val	number	Value to convert

Example

import { decibelToPower } from '@ircam/sc-utils';
decibelToPower(0);
// > 1

atodb(val) ⇒ number

Convert a linear gain into dB Alias: linearToDecibel

Kind: global function

Param	Type	Description
val	number	Value to convert

Example

import { atodb } from '@ircam/sc-utils';
atodb(0);
// > 1

linearToDecibel(val) ⇒ number

Convert a linear gain into dB Alias: atodb

Kind: global function

Param	Type	Description
val	number	Value to convert

Example

import { decibelToPower } from '@ircam/sc-utils';
decibelToPower(0);
// > 1

powerToDecibel(val) ⇒ number

Convert a linear gain into dB

Kind: global function

Param	Type	Description
val	number	Value to convert

Example

import { decibelToPower } from '@ircam/sc-utils';
decibelToPower(0);
// > 1

mtof(midiNote) ⇒ number

Convert a MIDI note to frequency

Kind: global function

Param	Type	Description
midiNote	number	MIDI Note to convert

Example

import { mtof } from '@ircam/sc-utils';
const freq = mtof(69);
// > 440

ftom(freq) ⇒ number

Convert a frequency to a MIDI note

Kind: global function

Param	Type	Description
freq	number	Frequency to convert

Example

import { ftom } from '@ircam/sc-utils';
const freq = ftom(440);
// > 69

linearScale(minIn, maxIn, minOut, maxOut, [clamp]) ⇒ function

Create a scale function

Kind: global function

Param	Type	Default	Description
minIn	number		Minimum input
maxIn	number		Maximum input
minOut	number		Minimum output
maxOut	number		Maximum output
[clamp]	boolean	false	Clamp output

Example

import { scale } from '@ircam/sc-utils';
const myScale = scale(0, 1, 50, 100);
myScale(0.5);
// > 75

idGenerator() ⇒ Iterator

Create a iterator of incrementing ids

Kind: global function
Example

import { idGenerator } from '@ircam/sc-utils';
const generator = idGenerator();
const id = generator.next().value

License

BSD-3-Clause