- v0.9.72Latest
- v0.9.71
- v0.9.70
- v0.9.68
- v0.9.67
- v0.9.66
- v0.9.65
- v0.9.64
- v0.9.63
- v0.9.62
- v0.9.61
- v0.9.60
- v0.9.58
- v0.9.57
- v0.9.56
- v0.9.55
- v0.9.54
- v0.9.53
- v0.9.52
- v0.9.51
- v0.9.50
- v0.9.42
- v0.9.41
- v0.9.40
- v0.9.35
- v0.9.34
- v0.9.33
- v0.9.32
- v0.9.30
- v0.9.20
- v0.9.19
- v0.9.18
- v0.9.17
- v0.9.16
- v0.9.15
- v0.9.14
- v0.9.13
- v0.9.12
- v0.9.11
- v0.9.10
- v0.9.8
- v0.9.7
- v0.9.6
- v0.9.5
- v0.9.4
- v0.9.3
- v0.9.2
- v0.9.1
- v0.9.0
- v0.8.43
- v0.8.41
- v0.8.40
- v0.8.30
- v0.8.25
- v0.8.24
- v0.8.23
- v0.8.22
- v0.8.21
- v0.8.20
- v0.8.11
- v0.8.10
- v0.8.9
- v0.8.8
- v0.8.7
- v0.8.6
- v0.8.5
- v0.8.4
- v0.8.3
- v0.8.2
- v0.8.1
- v0.8.0
- v0.7.11
- v0.7.10
- v0.7.8
- v0.7.7
- v0.7.6
- v0.7.5
- v0.7.4
- v0.7.3
- v0.7.2
- v0.7.0
- v0.6.31
- v0.6.30
- v0.6.29
- v0.6.27
- v0.6.26
- v0.6.25
- v0.6.24
- v0.6.22
- v0.6.21
- v0.6.20
- v0.6.18
- v0.6.17
- v0.6.16
- v0.6.15
- v0.6.14
- v0.6.13
- v0.6.12
- v0.6.11
- v0.6.10
- v0.6.9
- v0.6.8
- v0.6.7
- v0.6.6
- v0.6.5
- v0.6.4
- v0.6.3
- v0.6.2
- v0.6.1
- v0.6.0
- v0.5.7
- v0.5.5
- v0.5.3
- v0.5.2
- v0.5.1
- v0.5.0
- v0.4.6
- v0.4.5
- v0.4.4
- v0.4.3
- v0.4.2
- v0.4.1
- v0.4.0
JsExt
Additional functions for JavaScript programming in practice.
Install
npm i @ayonli/jsext
Usages
// Node.js
import jsext from "@ayonli/jsext";
// Deno
import jsext from "https://lib.deno.dev/x/ayonli_jsext@latest/index.ts"; // since v0.5.0
// Browser
import jsext from "https://lib.deno.dev/x/ayonli_jsext@latest/esm/index.js";
There is also a bundled version that can be loaded via a <script>
tag in the browser.
<script src="https://lib.deno.dev/x/ayonli_jsext@latest/bundle/index.js"></script>
<script>
const jsext = window["@ayonli/jsext"];
// this will also include the sub-packages and augmentations
<script>
Functions
- jsext.try
- jsext.func
- jsext.wrap
- jsext.throttle
- jsext.mixins
- jsext.isSubclassOf
- jsext.chan
- jsext.queue
- jsext.read
- jsext.readAll
- jsext.parallel
- jsext.run
- jsext.example
- jsext.deprecate
And other functions in sub-packages.
jsext.try
function _try<E = unknown, R = any, A extends any[] = any[]>(
fn: (...args: A) => R,
...args: A
): [E, R];
function _try<E = unknown, R = any, A extends any[] = any[]>(
fn: (...args: A) => Promise<R>,
...args: A
): Promise<[E, R]>;
Invokes a regular function or an async function and renders its result in an [err, res]
tuple.
Example
const [err, res] = _try(() => {
// do something that may fail
});
Example (async)
let [err, res] = await _try(async () => {
return await axios.get("https://example.org");
});
if (err) {
res = (err as any)["response"];
}
function _try<E = unknown, R = any>(job: Promise<R>): Promise<[E, R]>;
Resolves a promise and renders its result in an [err, res]
tuple.
Example
let [err, res] = await _try(axios.get("https://example.org"));
if (err) {
res = (err as any)["response"];
}
function _try<E = unknown, T = any, A extends any[] = any[], TReturn = any, TNext = unknown>(
fn: (...args: A) => Generator<T, TReturn, TNext>,
...args: A
): Generator<[E, T], [E, TReturn], TNext>;
function _try<E = unknown, T = any, A extends any[] = any[], TReturn = any, TNext = unknown>(
fn: (...args: A) => AsyncGenerator<T, TReturn, TNext>,
...args: A
): AsyncGenerator<[E, T], [E, TReturn], TNext>;
Invokes a generator function or an async generator function and renders its yield value and result
in an [err, val]
tuple.
Example
const iter = _try(function* () {
// do something that may fail
});
for (const [err, val] of iter) {
if (err) {
console.error("something went wrong:", err);
} else {
console.log("current value:", val);
}
}
Example (async)
const iter = _try(async function* () {
// do something that may fail
});
for await (const [err, val] of iter) {
if (err) {
console.error("something went wrong:", err);
} else {
console.log("current value:", val);
}
}
function _try<E = unknown, T = any, TReturn = any, TNext = unknown>(
gen: Generator<T, TReturn, TNext>
): Generator<[E, T], [E, TReturn], TNext>;
function _try<E = unknown, T = any, TReturn = any, TNext = unknown>(
gen: AsyncGenerator<T, TReturn, TNext>
): AsyncGenerator<[E, T], [E, TReturn], TNext>;
Resolves a generator or an async generator and renders its yield value and result in an [err, val]
tuple.
Example
const iter = Number.sequence(1, 10);
for (const [err, val] of _try(iter)) {
if (err) {
console.error("something went wrong:", err);
} else {
console.log("current value:", val);
}
}
Example (async)
async function* gen() {
// do something that may fail
};
for await (const [err, val] of _try(gen())) {
if (err) {
console.error("something went wrong:", err);
} else {
console.log("current value:", val);
}
}
jsext.func
function func<T, R = any, A extends any[] = any[]>(
fn: (this: T, defer: (cb: () => void) => void, ...args: A) => R
): (this: T, ...args: A) => R;
Inspired by Golang, creates a function that receives a defer
keyword which can be used
to carry deferred jobs that will be run after the main function is complete.
Multiple calls of the defer
keyword is supported, and the callbacks are called in the
LIFO order. Callbacks can be async functions if the main function is an async function or
an async generator function, and all the running procedures will be awaited.
Example
const getVersion = func(async (defer) => {
const file = await fs.open("./package.json", "r");
defer(() => file.close());
const content = await file.readFile("utf8");
const pkg = JSON.parse(content);
return pkg.version as string;
});
jsext.wrap
function wrap<T, Fn extends (this: T, ...args: any[]) => any>(
fn: Fn,
wrapper: (this: T, fn: Fn, ...args: Parameters<Fn>) => ReturnType<Fn>
): Fn
Wraps a function inside another function and returns a new function that copies the original functionās name and other properties.
Example
function log(text: string) {
console.log(text);
}
const show = wrap(log, function (fn, text) {
return fn.call(this, new Date().toISOString() + " " + text);
});
console.log(show.name); // log
console.log(show.length); // 1
console.assert(show.toString() === log.toString());
jsext.throttle
function throttle<T, Fn extends (this: T, ...args: any[]) => any>(
handler: Fn,
duration: number
): Fn;
function throttle<T, Fn extends (this: T, ...args: any[]) => any>(handler: Fn, options: {
duration: number;
/**
* Use the throttle strategy `for` the given key, this will keep the result in a global
* cache, binding new `handler` function for the same key will result in the same result
* as the previous, unless the duration has passed. This mechanism guarantees that both
* creating the throttled function in function scopes and overwriting the handler are
* possible.
*/
for?: any;
/**
* When turned on, respond with the last cache (if available) immediately, even if it has
* expired, and update the cache in the background.
*/
noWait?: boolean;
}): Fn;
Creates a throttled function that will only be run once in a certain amount of time.
If a subsequent call happens within the duration
(in milliseconds), the previous result will
be returned and the handler
function will not be invoked.
Example
const fn = throttle((input: string) => input, 1_000);
console.log(fn("foo")); // foo
console.log(fn("bar")); // foo
await Promise.sleep(1_000);
console.log(fn("bar")); // bar
Example (with key)
const out1 = await throttle(() => Promise.resolve("foo"), { duration: 1_000, for: "example" })();
console.log(out1); // foo
const out2 = await throttle(() => Promise.resolve("bar"), { duration: 1_000, for: "example" })();
console.log(out2); // foo
await Promise.sleep(1_000);
const out3 = await throttle(() => Promise.resolve("bar"), { duration: 1_000, for: "example" })();
console.log(out3); // bar
jsext.mixins
function mixins<T extends Constructor<any>, M extends any[]>(
base: T,
...mixins: { [X in keyof M]: Constructor<M[X]> }
): T & Constructor<UnionToIntersection<FlatArray<M, 1>>>;
function mixins<T extends Constructor<any>, M extends any[]>(
base: T,
...mixins: M
): T & Constructor<UnionToIntersection<FlatArray<M, 1>>>;
Returns an extended class that combines all mixin methods.
This function does not mutates the base class but create a pivot class instead.
Example
class Log {
log(text: string) {
console.log(text);
}
}
class View {
display(data: Record<string, any>[]) {
console.table(data);
}
}
class Controller extends mixins(View, Log) {
constructor(readonly topic: string) {
super();
}
}
const ctrl = new Controller("foo");
ctrl.log("something is happening");
ctrl.display([{ topic: ctrl.topic, content: "something is happening" }]);
console.assert(isSubclassOf(Controller, View));
console.assert(!isSubclassOf(Controller, Log));
jsext.isSubclassOf
function isSubclassOf<T, B>(ctor1: Constructor<T>, ctor2: Constructor<B>): boolean;
Checks if a class is a subclass of another class.
Example
class Moment extends Date {}
console.assert(isSubclassOf(Moment, Date));
console.assert(isSubclassOf(Moment, Object)); // all classes are subclasses of Object
jsext.chan
function chan<T>(capacity?: number): Channel<T>;
Inspired by Golang, cerates a channel that can be used to transfer data within the program.
If capacity
is not set, a non-buffered channel will be created. For a non-buffered channel,
the sender and receiver must be present at the same time (theoretically), otherwise, the
channel will block (non-IO aspect).
If capacity
is set, a buffered channel will be created. For a buffered channel, data will
be queued in the buffer first and then consumed by the receiver in FIFO order. Once the
buffer size reaches the capacity limit, no more data will be sent unless there is new space
available.
It is possible to set the capacity
to Infinity
to allow the channel to never block
and behave like a message queue.
Unlike EventEmitter
or EventTarget
, Channel
guarantees the data will always be delivered,
even if there is no receiver at the moment.
Also, unlike Golang, await channel.pop()
does not prevent the process from exiting.
Channel can be used to send and receive streaming data in worker threads, but once it has been
used that way, channel.close()
must be explicitly called in order to release the channel for
garbage collection.
Example
const channel = chan<number>();
(async () => {
await channel.push(123);
})();
const num = await channel.pop();
console.log(num);
// output:
// 123
Example (buffered)
const channel = chan<number>(3);
await channel.push(123);
await channel.push(456);
await channel.push(789);
const num1 = await channel.pop();
const num2 = await channel.pop();
const num3 = await channel.pop();
console.log(num1);
console.log(num2);
console.log(num3);
// output:
// 123
// 456
// 789
Example (iterable)
const channel = chan<number>();
(async () => {
for (const num of Number.sequence(1, 5)) {
await channel.push(num);
}
channel.close();
})();
for await (const num of channel) {
console.log(num);
}
// output:
// 1
// 2
// 3
// 4
// 5
jsext.queue
function queue<T>(handler: (data: T) => Promise<void>, bufferSize?: number): Queue<T>
Processes data sequentially by the given handler
function and prevents concurrency
conflicts, it returns a queue instance that we can push data into.
bufferSize
is the maximum capacity of the underlying channel, once reached, the push
operation will block until there is new space available. Bu default, this option is not set and
use a non-buffered channel instead.
Example
const list: string[] = [];
const q = queue(async (str: string) => {
await Promise.resolve(null);
list.push(str);
});
q.onError(err => {
console.error(err);
});
await q.push("foo");
await q.push("foo");
console.log(list.length);
q.close();
// output:
// 2
jsext.read
function read<I extends AsyncIterable<any>>(iterable: I): I;
function read(es: EventSource, options?: { event?: string; }): AsyncIterable<string>;
function read<T extends Uint8Array | string>(ws: WebSocket): AsyncIterable<T>;
function read<T>(target: EventTarget, eventMap?: {
message?: string;
error?: string;
close?: string;
}): AsyncIterable<T>;
function read<T>(target: NodeJS.EventEmitter, eventMap?: {
data?: string;
error?: string;
close?: string;
}): AsyncIterable<T>;
Wraps a source as an AsyncIterable object that can be used in the for await...of...
loop
for reading streaming data.
Example (EventSource)
// listen to the `onmessage`
const sse = new EventSource("/sse/message");
for await (const msg of read(sse)) {
console.log("receive message:", msg);
}
// listen to a specific event
const channel = new EventSource("/sse/broadcast");
for await (const msg of read(channel, { event: "broadcast" })) {
console.log("receive message:", msg);
}
Example (WebSocket)
const ws = new WebSocket("/ws");
for await (const data of read(ws)) {
if (typeof data === "string") {
console.log("receive text message:", data);
} else {
console.log("receive binary data:", data);
}
}
Example (EventTarget)
for await (const msg of read(self)) {
console.log("receive message from the parent window:", msg);
}
Example (EventEmitter)
for await (const msg of read(process)) {
console.log("receive message from the parent process:", msg);
}
jsext.readAll
function readAll<T>(iterable: AsyncIterable<T>): Promise<T[]>;
Reads all values from the iterable object at once.
Example
const file = fs.createReadStream("./package.json");
const chunks = await readAll(file);
jsext.parallel
function parallel<M extends { [x: string]: any; }>(
mod: string | (() => Promise<M>),
options?: {
/**
* Choose whether to use `worker_threads` or `child_process` for creating the worker
* thread. The default setting is `worker_threads`.
*
* In browsers and Deno, this option is ignored and will always use the web worker.
*
* We should always consider using `worker_threads` over `child_process` since it consumes
* less system resources. However, As I've tested, `process.send(json)` performs about
* 20% ~ 30% more efficient than `postMessage()`, so `child_process` along with `json`
* serialization may suits more for some edge scenarios.
*/
adapter?: "worker_threads" | "child_process";
/**
* When using `child_process` adapter, this option instructs which serialization algorithm
* should be used to serialize the data for transferring between the parent and the child
* process. The default setting is `advanced` (structured clone algorithm).
*
* NOTE: this option only works in Node.js, Bun doesn't support `json` serialization and
* will always use `advanced`.
*/
serialization?: "advanced" | "json";
}
): ThreadedFunctions<M>;
Wraps a module and run its functions in worker threads.
In Node.js and Bun, the module
can be either an ES module or a CommonJS module,
node_modules and built-in modules are also supported.
In browsers and Deno, the module
can only be an ES module.
In Bun and Deno, the module
can also be a TypeScript file.
Data are cloned and transferred between threads via Structured Clone Algorithm.
Apart from the standard data types supported by the algorithm, Channel
can also be
used to transfer data between threads. To do so, just passed a channel instance to the threaded
function.
But be aware, channel can only be used as a parameter, return a channel from the threaded function is not allowed. And the channel can only be used for one threaded function at a time, once passed, the data can only be transferred into and out-from the function.
The difference between using channel and generator function for streaming processing is, for a
generator function, next(value)
is coupled with a yield value
, the process is blocked
between next calls, channel doesnāt have this limitation, we can use it to stream all
the data into the function before processing and receiving any result.
Example (async function)
const mod = parallel(() => import("./examples/worker.mjs"));
console.log(await mod.greet("World")); // Hi, World
Example (async generator function)
const mod = parallel(() => import("./examples/worker.mjs"));
for await (const word of mod.sequence(["foo", "bar"])) {
console.log(word);
}
// output:
// foo
// bar
Example (use channel)
const mod = parallel(() => import("./examples/worker.mjs"));
const channel = chan<number>();
const length = mod.twoTimesValues(channel);
for (const value of Number.sequence(0, 9)) {
await channel.push({ value, done: value === 9 });
}
const results = (await readAll(channel)).map(item => item.value);
console.log(results);
console.log(await length);
// output:
// [0, 2, 4, 6, 8, 10, 12, 14, 16, 18]
// 10
NOTE: if the application is to be bundled, use the following syntax to link the module instead, it will prevent the bundler from including the file and rewriting the path.
const mod = parallel<typeof import("./examples/worker.mjs")>("./examples/worker.mjs");
namespace parallel {
/**
* The maximum number of workers allowed to exist at the same time.
*
* In Bun, Deno and browsers, the default value is set to
* `navigator.hardwareConcurrency`.
*
* In Node.js, the default value is `16`.
*/
export var maxWorkers: number;
/**
* In browsers, by default, the program loads the worker entry directly from GitHub,
* which could be slow due to poor internet connection, we can copy the entry file
* `bundle/worker.mjs` to a local path of our website and set this option to that path
* so that it can be loaded locally.
*
* Or, if the code is bundled, the program won't be able to automatically locate the entry
* file in the file system, in such case, we can also copy the entry file
* (`bundle/worker.mjs` for Bun, Deno and the browser, `bundle/worker-node.mjs` for Node.js)
* to a local directory and supply this option instead.
*/
export var workerEntry: string | undefined;
/**
* Marks the given data to be transferred instead of cloned to the worker thread.
* Once transferred, the data is no longer available on the sending end.
*
* Currently, only `ArrayBuffer` are guaranteed to be transferable across all supported
* JavaScript runtimes.
*
* Be aware, the transferable object can only be used as a parameter, return a transferable
* object from the threaded function is not supported and will always be cloned.
*
* NOTE: always prefer channel for transferring large amount of data in streaming fashion
* than sending them as transferrable objects, it consumes less memory and does not transfer
* the ownership of the data.
*/
export function transfer<T extends Transferable>(data: T): T;
}
Example (use transferable)
const mod = parallel(() => import("./examples/worker.mjs"));
const arr = Uint8Array.from([0, 1, 2]);
const length = await mod.transfer(parallel.transfer(arr.buffer));
console.assert(length === 3);
console.assert(arr.byteLength === 0);
jsext.run
function run<R, A extends any[] = any[]>(script: string, args?: A, options?: {
/** If not set, invoke the default function, otherwise invoke the specified function. */
fn?: string;
/** Automatically abort the task when timeout (in milliseconds). */
timeout?: number;
/**
* Instead of dropping the worker after the task has completed, keep it alive so that it can
* be reused by other tasks.
*/
keepAlive?: boolean;
/**
* Choose whether to use `worker_threads` or `child_process` for running the script.
* The default setting is `worker_threads`.
*
* In browsers and Deno, this option is ignored and will always use the web worker.
*/
adapter?: "worker_threads" | "child_process";
/**
* When using `child_process` adapter, this option instructs which serialization algorithm
* should be used to serialize the data for transferring between the parent and the child
* process. The default setting is `advanced` (structured clone algorithm).
*
* NOTE: this option only works in Node.js, Bun doesn't support `json` serialization and
* will always use `advanced`.
*/
serialization?: "advanced" | "json";
}): Promise<{
workerId: number;
/** Retrieves the return value of the function that has been called.. */
result(): Promise<R>;
/** Iterates the yield value if the function returns a generator. */
iterate(): AsyncIterable<R>;
/** Terminates the worker thread and aborts the task. */
abort(reason?: unknown): Promise<void>;
}>;
Runs the given script
in a worker thread or child process.
In Node.js and Bun, the script
can be either a CommonJS module or an ES module, and is relative to
the current working directory if not absolute.
In browsers and Deno, the script
can only be an ES module, and is relative to the current URL
(or working directory for Deno) if not absolute.
In Bun and Deno, the script
can also be a TypeScript file.
This function also uses parallel.maxWorkers
and parallel.workerEntry
for worker
configuration.
parallel.transfer()
and Channel
can also be used to transfer large or
streaming data, but be aware transferable objects only work with worker_threads
adapter.
Example (result)
const job1 = await run<string, [string]>("examples/worker.mjs", ["World"]);
console.log(await job1.result()); // Hello, World
Example (iterate)
const job2 = await run<string, [string[]]>("examples/worker.mjs", [["foo", "bar"]], {
fn: "sequence",
});
for await (const word of job2.iterate()) {
console.log(word);
}
// output:
// foo
// bar
Example (abort)
const job3 = await run<string, [string]>("examples/worker.mjs", ["foobar"], {
fn: "takeTooLong",
});
await job3.abort();
const [err, res] = await _try(job3.result());
console.assert(err === null);
console.assert(res === undefined);
jsext.example
function example<T, A extends any[] = any[]>(
fn: (this: T, console: Console, ...args: A) => void | Promise<void>,
options?: {
/** Suppress logging to the terminal and only check the output. */
suppress?: boolean;
}
): (this: T, ...args: A) => Promise<void>;
Inspired by Golangās Example as Test design, creates a function that carries example code
with // output:
comments, when the returned function is called, it will automatically check if
the actual output matches the one declared in the comment.
The example function receives a customized console
object which will be used to log outputs
instead of using the built-in console
.
NOTE: this function is used to simplify the process of writing tests, it does not work in Bun and
browsers currently, because Bun hasnāt implement the Console
constructor and removes comments
during runtime, and the function relies on Node.js built-in modules.
Example
it("should output as expected", example(console => {
console.log("Hello, World!");
// output:
// Hello, World!
}));
jsext.deprecate
function deprecate<T, Fn extends (this: T, ...args: any[]) => any>(
fn: Fn,
tip?: string,
once?: boolean
): Fn;
Marks a function as deprecated and returns a wrapped function.
When the wrapped function is called, a deprecation warning will be emitted to the stdout.
NOTE: the original function must have a name.
Example
const sum = deprecate(function sum(a: number, b: number) {
return a + b;
}, "use `a + b` instead");
console.log(sum(1, 2));
// output:
// DeprecationWarning: sum() is deprecated, use `a + b` instead (at <anonymous>:4:13)
// 3
function deprecate(target: string, forFn: Function, tip?: string, once?: boolean): void;
Emits a deprecation warning for the target, usually a parameter, an option, or the functionās name, etc.
Example
const pow = function pow(a: number, b: number) {
deprecate("pow()", pow, "use `a ** b` instead");
return a ** b;
};
console.log(pow(2, 3));
// output:
// DeprecationWarning: pow() is deprecated, use `a ** b` instead (at <anonymous>:5:13)
// 8
Types
Channel<T>
Queue<T>
AsyncFunction
AsyncGeneratorFunction
AsyncFunctionConstructor
Constructor<T>
TypedArray
Optional<T, K extends keyof T>
Ensured<T, K extends keyof T>
When augmenting, these types are exposed to
the global scope (except for Channel
and Queue
).
Sub-packages
NOTE: Configure tsconfig.json
to set compilerOptions.module
as NodeNext
or ESNext
instead of CommonJS
in order to use sub-packages.
NOTE: The following examples of import IDs uses Node.js style, but they have Deno and browser equivalents, like this:
- Node.js
@ayonli/jsext/string
- Deno:
https://lib.deno.dev/x/ayonli_jsext@latest/string/index.ts
- Browser:
https://lib.deno.dev/x/ayonli_jsext@latest/esm/string/index.js
string
import { compare, random, /* ... */ } from "@ayonli/jsext/string";
// or
import "@ayonli/jsext/string/augment";
Functions
compare(str1: string, str2: string): -1 | 0 | 1
random(length: number): string
count(str: string, sub: string): number
capitalize(str: string, all?: boolean): string
hyphenate(str: string): string
words(str: string): string[]
chunk(str: string, length: number): string[]
truncate(str: string, length: number): string
trim(str: string, chars?: string): string
trimEnd(str: string, chars?: string): string
trimStart(str: string, chars?: string): string
byteLength(str: string): number
String
compare(str1: string, str2: string): -1 | 0 | 1
random(length: number): string
prototype
count(sub: string): number
capitalize(all?: boolean): string
hyphenate(): string
words(): string[]
chunk(length: number): string[]
truncate(length: number): string
trim(chars?: string): string
trimEnd(chars?: string): string
trimStart(chars?: string): string
byteLength(): number
number
import { isFloat, isNumeric, /* ... */ } from "@ayonli/jsext/number";
// or
import "@ayonli/jsext/number/augment";
Functions
isFloat(value: unknown): boolean
isNumeric(value: unknown): boolean
isBetween(value: number, [min, max]: [number, number]): boolean
random(min: number, max: number): number
sequence(min: number, max: number, step?: number, loop?: boolean): Generator<number, void, unknown>
When augmenting, these functions
are attached to the Number
constructor.
array
import { count, equals, /* ... */ } from "@ayonli/jsext/array";
// or
import "@ayonli/jsext/array/augment";
Functions
count<T>(arr: RealArrayLike<T>, ele: T): number
equals<T>(arr1: RealArrayLike<T>, arr2: RealArrayLike<T>): boolean
split<T>(arr: RealArrayLike<T>, delimiter: T): RealArrayLike<T>[]
chunk<T>(arr: RealArrayLike<T>, length: number): RealArrayLike<T>[]
uniq<T>(arr: T[]): T[]
shuffle<T>(arr: T[]): T[]
orderBy<T>(arr: T[], key: keyof T, order: "asc" | "desc" = "asc"): T[]
groupBy<T>(arr: T[], fn: (item: T, i: number) => string | symbol, type?: ObjectConstructor): Record<string | symbol, T[]>
groupBy<T, K extends string>(arr: T[], fn: (item: T, i: number) => K, type: MapConstructor): Map<K, T[]>
Array<T>
prototype
first(): T
last(): T
count(ele: T): number
equals(another: T[]): boolean
split(delimiter: T): T[][]
chunk(length: number): T[][]
uniq(): T[]
shuffle(): T[]
toShuffled(): T[]
toReversed(): T[]
toSorted(fn?: ((a: T, b: T) => number) | undefined): T[]
orderBy(key: keyof T, order?: "asc" | "desc"): T[]
groupBy(fn: (item: T, i: number) => string | symbol, type?: ObjectConstructor): Record<string | symbol, T[]>
groupBy<K>(fn: (item: T, i: number) => K, type: MapConstructor): Map<K, T[]>
uint8array
import { compare, equals, /* ... */ } from "@ayonli/jsext/uint8array";
// or
import "@ayonli/jsext/uint8array/augment";
Functions
compare(arr1: Uint8Array, arr2: Uint8Array): -1 | 0 | 1
equals(arr1: Uint8Array, arr2: Uint8Array): boolean
split<T extends Uint8Array>(arr: T, delimiter: number): T[]
chunk<T extends Uint8Array>(arr: T, length: number): T[]
Uint8Array
compare(arr1: Uint8Array, arr2: Uint8Array): -1 | 0 | 1
prototype
equals(another: Uint8Array): boolean
split(delimiter: number): this[]
chunk(length: number): this[]
object
import { hasOwn, hasOwnMethod, /* ... */ } from "@ayonli/jsext/object";
// or
import "@ayonli/jsext/object/augment";
Functions
hasOwn(obj: any, key: string | number | symbol): boolean
hasOwnMethod(obj: any, method: string | symbol): boolean
patch<T extends {}, U>(target: T, source: U): T & U
patch<T extends {}, U, V>(target: T, source1: U, source2: V): T & U & V
patch<T extends {}, U, V, W>(target: T, source1: U, source2: V, source3: W): T & U & V & W
patch(target: object, ...sources: any[]): any
pick<T extends object, U extends keyof T>(obj: T, keys: U[]): Pick<T, U>
pick<T>(obj: T, keys: (string | symbol)[]): Partial<T>
omit<T extends object, U extends keyof T>(obj: T, keys: U[]): Omit<T, U>
omit<T>(obj: T, keys: (string | symbol)[]): Partial<T>
as(value: unknown, type: StringConstructor): string | null
as(value: unknown, type: NumberConstructor): number | null
as(value: unknown, type: BigIntConstructor): bigint | null
as(value: unknown, type: BooleanConstructor): boolean | null
as(value: unknown, type: SymbolConstructor): symbol | null
as<T>(value: unknown, type: Constructor<T>): T | null
isValid(value: unknown): boolean
When augmenting, these functions
are attached to the Object
constructor.
math
import { sum, avg, /* ... */ } from "@ayonli/jsext/math";
// or
import "@ayonli/jsext/math/augment";
Functions
sum(...values: number[]): number
avg(...values: number[]): number
product(...values: number[]): number
When augmenting, these functions
are attached to the Math
namespace.
promise
import { timeout, after, /* ... */ } from "@ayonli/jsext/promise";
// or
import "@ayonli/jsext/promise/augment";
Functions
timeout<T>(value: T | PromiseLike<T>, ms: number): Promise<T>
after<T>(value: T | PromiseLike<T>, ms: number): Promise<T>
sleep(ms: number): Promise<void>
until(test: () => boolean | Promise<boolean>): Promise<void>
When augmenting, these functions
are attached to the Promise
constructor.
collections
import BiMap from "@ayonli/jsext/collections/BiMap";
import CiMap from "@ayonli/jsext/collections/CiMap";
// or
import { BiMap, CiMap } from "@ayonli/jsext/collections";
// or
import "@ayonli/jsext/collections/augment";
Types
BiMap<K, V>
(extendsMap<K, V>
) Bi-directional map, keys and values are unique and map to each other.prototype
(additional)getKey(value: V): K | undefined
hasValue(value: V): boolean
deleteValue(value: V): boolean
CiMap<K extends string, V>
(implementsMap<K, V>
) Case-insensitive map, keys are case-insensitive.
When augmenting, these types are exposed to the global scope.
error
import Exception from "@ayonli/jsext/error/Exception";
// or
import { Exception } from "@ayonli/jsext/error";
// or
import "@ayonli/jsext/error/augment";
Types
Exception
(extendsError
)cause?: unknown
code: number
When augmenting, these types are exposed to the global scope.
Functions
toObject<T extends Error>(err: T): { [x: string | symbol]: any; }
fromObject<T extends Error>(obj: { [x: string | symbol]: any; }): T
Error
toObject<T extends Error>(err: T): { [x: string | symbol]: any; }
fromObject<T extends Error>(obj: { [x: string | symbol]: any; }): T
prototype
toJSON(): { [x: string | symbol]: any; }
json
import { parseAs } from "@ayonli/jsext/json";
// or
import "@ayonli/jsext/json/augment";
Functions
parseAs(text: string, type: StringConstructor): string | null
parseAs(text: string, type: NumberConstructor): number | null
parseAs(text: string, type: BigIntConstructor): bigint | null
parseAs(text: string, type: BooleanConstructor): boolean | null
parseAs<T>(text: string, type: Constructor<T> & { fromJSON?(data: any): T; }): T | null
as(data: unknown, type: StringConstructor): string | null
as(data: unknown, type: NumberConstructor): number | null
as(data: unknown, type: BigIntConstructor): bigint | null
as(data: unknown, type: BooleanConstructor): boolean | null
as<T>(data: unknown, type: Constructor<T> & { fromJSON?(data: any): T; }): T | null
type(ctor: Constructor<any>): PropertyDecorator
When augmenting, these functions
are attached to the JSON
namespace.
Import all sub-package augmentations at once
import "@ayonli/jsext/augment";
When to use augmentations
If weāre developing libraries and share them publicly, in order to prevent collision, itās better not to use augmentations, but use the corresponding functions from the sub-packages instead.
But if weāre developing private application, using augmentations can save a lot of time, itās easier to read and write, and make sense.