Add comprehensive installation and setup documentation

- Add GETTING_STARTED.md with quick start guide and development modes
- Add INSTALL.sh automated installation script
- Add INSTALLATION_CHECKLIST.md, INSTALLATION_SUCCESS.md, and INSTALLATION_SUMMARY.md
- Add QUICK_REFERENCE.md for common commands
- Add SETUP_GUIDE.md with detailed setup instructions
- Update README.md with improved project overview
- Add did-wallet app dependencies and node_modules
This commit is contained in:
Dorian
2026-01-27 17:18:21 +00:00
parent a81f655133
commit 0d073fa89e
22658 changed files with 4494151 additions and 6 deletions
+70
View File
@@ -0,0 +1,70 @@
# err-code
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency status][david-dm-image]][david-dm-url] [![Dev Dependency status][david-dm-dev-image]][david-dm-dev-url] [![Greenkeeper badge][greenkeeper-image]][greenkeeper-url]
[npm-url]:https://npmjs.org/package/err-code
[downloads-image]:http://img.shields.io/npm/dm/err-code.svg
[npm-image]:http://img.shields.io/npm/v/err-code.svg
[travis-url]:https://travis-ci.org/IndigoUnited/js-err-code
[travis-image]:http://img.shields.io/travis/IndigoUnited/js-err-code/master.svg
[david-dm-url]:https://david-dm.org/IndigoUnited/js-err-code
[david-dm-image]:https://img.shields.io/david/IndigoUnited/js-err-code.svg
[david-dm-dev-url]:https://david-dm.org/IndigoUnited/js-err-code?type=dev
[david-dm-dev-image]:https://img.shields.io/david/dev/IndigoUnited/js-err-code.svg
[greenkeeper-image]:https://badges.greenkeeper.io/IndigoUnited/js-err-code.svg
[greenkeeper-url]:https://greenkeeper.io/
Create new error instances with a code and additional properties.
## Installation
```console
$ npm install err-code
// or
$ bower install err-code
```
The browser file is named index.umd.js which supports CommonJS, AMD and globals (errCode).
## Why
I find myself doing this repeatedly:
```js
var err = new Error('My message');
err.code = 'SOMECODE';
err.detail = 'Additional information about the error';
throw err;
```
## Usage
Simple usage.
```js
var errcode = require('err-code');
// fill error with message + code
throw errcode(new Error('My message'), 'ESOMECODE');
// fill error with message + code + props
throw errcode(new Error('My message'), 'ESOMECODE', { detail: 'Additional information about the error' });
// fill error with message + props
throw errcode(new Error('My message'), { detail: 'Additional information about the error' });
```
## Pre-existing fields
If the passed `Error` already has a `.code` field, or fields specified in the third argument to `errcode` they will be overwritten, unless the fields are read only or otherwise throw during assignment in which case a new object will be created that shares a prototype chain with the original `Error`. The `.stack` and `.message` properties will be carried over from the original error and `.code` or any passed properties will be set on it.
## Tests
`$ npm test`
## License
Released under the [MIT License](http://www.opensource.org/licenses/mit-license.php).
+16
View File
@@ -0,0 +1,16 @@
export = createError;
/**
*
* @param {any} err - An Error
* @param {string|Extensions} code - A string code or props to set on the error
* @param {Extensions} [props] - Props to set on the error
* @returns {Error & Extensions}
*/
declare function createError(err: any, code: string | Extensions, props?: Extensions | undefined): Error & Extensions;
declare namespace createError {
export { Extensions, Err };
}
type Extensions = {
[key: string]: any;
};
type Err = Error;
+69
View File
@@ -0,0 +1,69 @@
'use strict';
/**
* @typedef {{ [key: string]: any }} Extensions
* @typedef {Error} Err
* @property {string} message
*/
/**
*
* @param {Error} obj
* @param {Extensions} props
* @returns {Error & Extensions}
*/
function assign(obj, props) {
for (const key in props) {
Object.defineProperty(obj, key, {
value: props[key],
enumerable: true,
configurable: true,
});
}
return obj;
}
/**
*
* @param {any} err - An Error
* @param {string|Extensions} code - A string code or props to set on the error
* @param {Extensions} [props] - Props to set on the error
* @returns {Error & Extensions}
*/
function createError(err, code, props) {
if (!err || typeof err === 'string') {
throw new TypeError('Please pass an Error to err-code');
}
if (!props) {
props = {};
}
if (typeof code === 'object') {
props = code;
code = '';
}
if (code) {
props.code = code;
}
try {
return assign(err, props);
} catch (_) {
props.message = err.message;
props.stack = err.stack;
const ErrClass = function () {};
ErrClass.prototype = Object.create(Object.getPrototypeOf(err));
// @ts-ignore
const output = assign(new ErrClass(), props);
return output;
}
}
module.exports = createError;
+73
View File
@@ -0,0 +1,73 @@
(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.errCode = f()}})(function(){var define,module,exports;return (function(){function r(e,n,t){function o(i,f){if(!n[i]){if(!e[i]){var c="function"==typeof require&&require;if(!f&&c)return c(i,!0);if(u)return u(i,!0);var a=new Error("Cannot find module '"+i+"'");throw a.code="MODULE_NOT_FOUND",a}var p=n[i]={exports:{}};e[i][0].call(p.exports,function(r){var n=e[i][1][r];return o(n||r)},p,p.exports,r,e,n,t)}return n[i].exports}for(var u="function"==typeof require&&require,i=0;i<t.length;i++)o(t[i]);return o}return r})()({1:[function(require,module,exports){
'use strict';
/**
* @typedef {{ [key: string]: any }} Extensions
* @typedef {Error} Err
* @property {string} message
*/
/**
*
* @param {Error} obj
* @param {Extensions} props
* @returns {Error & Extensions}
*/
function assign(obj, props) {
for (const key in props) {
Object.defineProperty(obj, key, {
value: props[key],
enumerable: true,
configurable: true,
});
}
return obj;
}
/**
*
* @param {any} err - An Error
* @param {string|Extensions} code - A string code or props to set on the error
* @param {Extensions} [props] - Props to set on the error
* @returns {Error & Extensions}
*/
function createError(err, code, props) {
if (!err || typeof err === 'string') {
throw new TypeError('Please pass an Error to err-code');
}
if (!props) {
props = {};
}
if (typeof code === 'object') {
props = code;
code = '';
}
if (code) {
props.code = code;
}
try {
return assign(err, props);
} catch (_) {
props.message = err.message;
props.stack = err.stack;
const ErrClass = function () {};
ErrClass.prototype = Object.create(Object.getPrototypeOf(err));
// @ts-ignore
const output = assign(new ErrClass(), props);
return output;
}
}
module.exports = createError;
},{}]},{},[1])(1)
});
+45
View File
@@ -0,0 +1,45 @@
{
"name": "err-code",
"version": "3.0.1",
"description": "Create an error with a code",
"main": "index.js",
"types": "dist/index.d.ts",
"scripts": {
"lint": "eslint '{./*.js,test/**/*.js}'",
"check": "tsc --noEmit",
"prepare": "tsc --emitDeclarationOnly --declarationDir dist",
"test": "mocha --bail",
"prepublishOnly": "browserify -s err-code index.js > index.umd.js"
},
"bugs": {
"url": "https://github.com/IndigoUnited/js-err-code/issues/"
},
"repository": {
"type": "git",
"url": "git://github.com/IndigoUnited/js-err-code.git"
},
"keywords": [
"error",
"err",
"code",
"properties",
"property"
],
"author": "IndigoUnited <hello@indigounited.com> (http://indigounited.com)",
"license": "MIT",
"devDependencies": {
"@satazor/eslint-config": "^3.0.0",
"@types/expect.js": "0.3.29",
"@types/mocha": "8.2.0",
"browserify": "^17.0.0",
"eslint": "^7.19.0",
"expect.js": "^0.3.1",
"mocha": "^8.2.1",
"typescript": "^4.1.3"
},
"files": [
"index.js",
"index.umd.js",
"dist/index.d.ts"
]
}