🎉 Initial Code

Author: harshzalavadiya

.github/workflows/nodejs.yml

@@ -0,0 +1,38 @@
+name: NodeJS
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: ["10"]
+    name: Node ${{ matrix.node }}
+    steps:
+      - uses: actions/checkout@v1
+      - name: Setup node
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Setup Yarn
+        run: npm install -g yarn
+
+      - name: Install
+        run: yarn install
+
+      - name: Build
+        run: yarn build
+
+      - name: Test
+        run: yarn test
+
+      - name: Coverage
+        run: yarn coverage
+
+      - name: Publish
+        if: startsWith(github.ref, 'refs/tags/')
+        run: echo "//registry.npmjs.org/:_authToken=$NPM_AUTH_TOKEN" > ~/.npmrc && npm publish --access public
+        env:
+          NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

.gitignore

@@ -0,0 +1,9 @@
+node_modules
+yarn-error.log
+coverage
+dist
+
+.rts2_cache_cjs
+.rts2_cache_es
+.rts2_cache_umd
+.vscode

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Harsh Zalavadiya
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,35 @@
+# Friendly Http Status
+
+Translates http status code to minimal friendly object containing description and emoji 😃
+
+## 🔧 Installation
+
+```sh
+npm i friendly-http-status
+```
+
+## 📦 Usage
+
+```javascript
+import { getFriendlyError } from "friendly-http-status";
+
+console.log(getFriendlyError(404));
+```
+
+## 👀 Response
+
+`getFriendlyError` always returns json object with following property even if code unknown it will return unknown error object
+
+```json
+{
+  "emoji": "❓",
+  "message": "Not Found",
+  "description": "The requested page could not be found but may be available again in the future."
+}
+```
+
+## 🤠 Credits
+
+- Emoji dataset is taken from [http-status-extra](https://github.com/aasaam/http-status-extra) and stripped to minimal
+- [microbundle](https://github.com/developit/microbundle) for packaging
+- [TypeScript](https://github.com/microsoft/TypeScript)

index.ts

@@ -0,0 +1 @@
+export { getFriendlyError } from "./src/";

jest.json

@@ -0,0 +1,7 @@
+{
+  "roots": ["<rootDir>/src"],
+  "transform": {
+    "^.+\\.tsx?$": "ts-jest"
+  },
+  "testMatch": ["**/__tests__/**/*-spec.ts"]
+}

package.json

@@ -0,0 +1,26 @@
+{
+  "name": "friendly-http-status",
+  "version": "1.0.0",
+  "description": "Translates http status code to friendly object containing description and emoji",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "repository": "harshzalavadiya/friendly-http-status",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "test": "jest --config=jest.json",
+    "coverage": "jest --coverage --config=jest.json",
+    "dev": "microbundle watch",
+    "build": "microbundle"
+  },
+  "author": "Harsh Zalavadiya <harsh@foobars.in> (twitter: @zhnebula)",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "^24.0.18",
+    "jest": "^24.9.0",
+    "microbundle": "^0.11.0",
+    "ts-jest": "^24.1.0"
+  },
+  "dependencies": {}
+}

src/__tests__/index-spec.ts

@@ -0,0 +1,16 @@
+import { getFriendlyError } from "..";
+import { defaultErrorCode, errorData } from "../error-data";
+
+const errorCodes = Object.keys(errorData);
+
+for (const errorCode of errorCodes) {
+  test(`should return proper ${errorCode} response`, () => {
+    const errorResponseObject = getFriendlyError(parseInt(errorCode));
+    expect(errorResponseObject).toEqual(errorData[errorCode]);
+  });
+}
+
+test("should return unknown error object on not found", () => {
+  const messageObject = getFriendlyError(1001);
+  expect(messageObject).toEqual(defaultErrorCode);
+});