Documentation

[mvastola]

This is an extremely popular node module, yet I have no idea what it does (beyond the one-line description), or how to use it. I think it might be what I need for a project based on this description, but it's very hard to tell given the lack of any information about it anywhere on the internet.

It seems to only have a few main functions that are widely used. Would it be possible for them to be documented?

[anka-213]

Do you have any specific questions relating to your use case? It could be a good starting point for writing documentation.

You could also look at the tests here for a few examples of how to use the library:

Here is an example of some simple usage:

optimism/src/tests/api.ts

Lines 502 to 512 in 5cb1695

	const fib: OptimisticWrapperFunction<[number], number> =
	wrap(function (n: number) {
	if (n > 1) {
	return fib(n - 1) + fib(n - 2);
	}
	return n;
	}, {
	max: 10
	});
	assert.strictEqual(fib(78), 8944394323791464);

Here is another example with some more intricate behaviour:

optimism/src/tests/api.ts

Lines 196 to 215 in 5cb1695

	it("marks evicted cache entries dirty", function () {
	let childSalt = "*";
	let child = wrap(function (x: string) {
	return x + childSalt;
	}, { max: 1 });
	let parentSalt = "^";
	const parent = wrap(function (x: string) {
	return child(x) + parentSalt;
	});
	assert.strictEqual(parent("asdf"), "asdf*^");
	childSalt = "&";
	parentSalt = "%";
	assert.strictEqual(parent("asdf"), "asdf*^");
	assert.strictEqual(child("zxcv"), "zxcv&");
	assert.strictEqual(parent("asdf"), "asdf&%");
	});