Add documentation
This commit is contained in:
+10
-8
@@ -1,11 +1,13 @@
|
||||
# @welshman/lib [](https://npmjs.com/package/@welshman/lib)
|
||||
|
||||
Some general-purpose utilities used elsewhere in @welshman.
|
||||
Some general-purpose utilities for use in @welshman apps.
|
||||
|
||||
- `Deferred` is just a promise with `resolve` and `reject` methods.
|
||||
- `Emitter` extends EventEmitter to support `emitter.on('*', ...)`.
|
||||
- `Fluent` is a wrapper around arrays with chained methods that modify and copy the underlying array.
|
||||
- `LRUCache` is an implementation of an LRU cache.
|
||||
- `Worker` is an implementation of an asynchronous queue.
|
||||
- `Tools` is a collection of general-purpose utility functions.
|
||||
- `Store` is an implementation of svelte-like subscribable stores with extra features.
|
||||
Includes:
|
||||
|
||||
- LRU cache implementation
|
||||
- Worker for throttling work to avoid locking up the UI
|
||||
- URL normalization (taken from normalize-url)
|
||||
- A global `ctx` variable which can be used for global configuration
|
||||
- CustomPromise, which provides an error type, and `defer` utility
|
||||
- Ramda-like utilities, but without auto-currying
|
||||
- Utils for throttling, working with nil, json, fetch, deep equals, etc.
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"exclude": ["normalize-url/*"],
|
||||
"entryPoints": ["src/index.ts"]
|
||||
}
|
||||
Reference in New Issue
Block a user