https://github.com/edgeapp/edge-server-tools

https://github.com/edgeapp/edge-server-tools

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/edgeapp/edge-server-tools
• Owner: EdgeApp
• Created: 2021-02-08T22:50:31.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-11T17:26:43.000Z (over 1 year ago)
• Last Synced: 2024-11-03T01:02:12.709Z (over 1 year ago)
• Language: TypeScript
• Size: 304 KB
• Stars: 1
• Watchers: 9
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          
# edge-server-utils

The [Edge Wallet](https://edge.app) uses a variety of back-end micro-services, including encrypted key backup, exchange rates, mining fees, and so forth. Most of these services use an Express frontend talking touch a CouchDB database, so this library contains common utility functions for working with these technologies.

Cleaners:

- [`asCouchDoc`](./docs/as-couch-doc.md) - A cleaner for dealing with the `_id` and `_rev` fields CouchDB adds to documents.

- [`asHealingObject`](./docs/as-healing-object.md) - A cleaner for repairing damaged objects using default values.

- [`asMaybeConflictError`] - Passes for a CouchDB conflict error.

- [`asMaybeExistsError`] - Passes for a CouchDB item exists error.

- [`asMaybeNotFoundError`] - Passes for a CouchDB item missing error.

CouchDB utilities:

- `bulkGet` - Nano forgot to implement this method for some reason.

- `makeRollingDatabase` - Treats a collection of databases as a single large database, organized by date range.

- [`viewToStream`](./docs/view-to-stream.md) - Iterates over the documents in a database, partition, or view.

CouchDB setup tools:

- [`setupDatabase`](./docs/couch-setup.md) - Automatically creates a database, sets up replication and design documents, and subscribes to the changes feed.

- [`makeJsDesign`](./docs/couch-setup.md#makeJsDesign) - Creates a JavaScript design document.

- [`makeMangoIndex`](./docs/couch-setup.md#makeMangoIndex) - Creates a Mango index design document.

- [`syncedDocument`](./docs/couch-setup.md#watching-settings-documents) - Watches a settings document for changes.

AggregateError tools:

- [`AggregateError`] - A ponyfill for the new ES2021 AggregateError type.

- [`promiseAny`] - A ponyfill for the new ES2021 `Promise.any` method.

- [`stringifyError`] - Turns an error into a string, with special handling for `AggregateError`.

Other stuff:

- `forkChildren` - Used for Node.js clustering.

- `errorCause` - Adds an `error.cause` property.

- `matchJson` - Returns `true` if two JSON-style objects match.

- `makePeriodicTask` - Starts a periodic async task, with error handling and other features.

Deprecated stuff:

- `autoReplication` - Deprecated. Use the new `setupDatabase` stuff.

- `createAdminUser`

- `createRegularUser`

- [`forEachDocument`](./docs/for-each-document.md) - Iterates over the documents in a Couch database. Use `viewToStream` instead.