@dizmo/functions-buffered

Returns a buffered and cancelable version for the provided function. The buffered function does not execute before the specified delay passes upon which it executes exactly once, no matter have many times it gets invoked in between.

The cancellation of a particular invocation is only possible while the specified delay has not passed yet. Further, upon the invocation of the buffered function a promise is returned.

Usage

$3

``sh
npm install @dizmo/functions-buffered --save
`

$3

`javascript
const { buffered } = require("@dizmo/functions-buffered");
`

$3

`typescript
import { buffered } from "@dizmo/functions-buffered";
`

`typescript
let fn = buffered((t: Date) => {
return new Date().getTime() - t.getTime();
}, 200);

fn(new Date()).then((res: number) => {
console.debug(res);
}).catch((err: Error) => {
console.error(err);
});
`

`typescript
let fn = buffered(() => {
throw new Error("won't be thrown");
}, 600);

fn().then((res: any) => { // won't execute!
console.debug(res);
}).catch((err: Error) => {
console.error(err);
});

fn.cancel();
`

`typescript
class Class {
@buffered.decorator(100)
public async f1(t: Date): Promise {
return new Date().getTime() - t.getTime();
}
@buffered.decorator // 200ms default
public async f2(t: Date) {
return new Date().getTime() - t.getTime();
}
}

const p1: Promise
= new Class().f1(new Date());
const p2
= new Class().f2(new Date());

p1.then((res: number) => { console.debug(res); });
p2.then((res: number) => { console.debug(res); });
`

Development

$3

`sh
npm run clean
`

$3

`sh
npm run build
`

#### without linting and cleaning:

`sh
npm run -- build --no-lint --no-clean
`

#### with UMD bundling (incl. minimization):

`sh
npm run -- build --prepack
`

#### with UMD bundling (excl. minimization):

`sh
npm run -- build --prepack --no-minify
`

$3

`sh
npm run lint
`

#### with auto-fixing:

`sh
npm run -- lint --fix
`

$3

`sh
npm run test
`

#### without linting, cleaning and (re-)building:

`sh
npm run -- test --no-lint --no-clean --no-build
`

$3

`sh
npm run cover
`

#### without linting, cleaning and (re-)building:

`sh
npm run -- cover --no-lint --no-clean --no-build
`

Documentation

`sh
npm run docs
`

Publish

`sh
npm publish
`

#### initially (if public):

`sh
npm publish --access=public
``

Copyright

© 2020 dizmo AG, Switzerland