Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kkeeth/status-i18n
https://github.com/kkeeth/status-i18n
Last synced: 27 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/kkeeth/status-i18n
- Owner: kkeeth
- License: mit
- Created: 2024-09-03T07:54:01.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-03T12:03:54.000Z (4 months ago)
- Last Synced: 2024-12-09T00:37:15.607Z (about 1 month ago)
- Language: JavaScript
- Size: 335 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# status-i18n
[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]
[![Node.js Version][node-version-image]][node-version-url]
[![Build Status][ci-image]][ci-url]
[![Test Coverage][coveralls-image]][coveralls-url]
HTTP status and message mapping, internationalized.
Currently supported locales: `de-de`, `en-us`, `ja-jp`, `ko-kr`, `zh-cn`. Add your locale [like this](https://github.com/http-util/status-i18n/pull/48) now! 🎉
## Installation
```sh
$ npm install @http-util/status-i18n
```
## API
```js
import status from '@http-util/status-i18n'
// or
var status = require('@http-util/status-i18n')
```
### status.BROWSER_LANG
Returns a lowercase string of default browser language set by user.
### status.codes
Returns an array of all the status codes as `Integer`s.
### status[code]
Map of `code` to `status message`, in the same format as the [Node.js http module](https://nodejs.org/dist/latest/docs/api/http.html#http_http_status_codes). `undefined` for invalid `code`s. The language has been set to default `en-us`.
```js
status[404] // => 'Not Found'
status[700] // => undefined
```
### status(code, language)
Map of `code` to `status message` with specific language. The default browser language is assumed to be `en-us`.
```js
status(401, 'zh-cn') // => '无权限'
status(401, 'zh-CN') // => '无权限'
status(401, 'zh') // => '无权限'
status(401, status.BROWSER_LANG) // => 'Unauthorized'
status(401) // => 'Unauthorized'
```
[ci-image]: https://img.shields.io/github/actions/workflow/status/http-util/status-i18n/ci.yml
[ci-url]: https://github.com/http-util/status-i18n/actions/workflows/ci.yml
[npm-image]: https://img.shields.io/npm/v/@http-util/status-i18n.svg
[npm-url]: https://npmjs.org/package/@http-util/status-i18n
[node-version-image]: https://img.shields.io/node/v/@http-util/status-i18n.svg
[node-version-url]: https://www.npmjs.com/package/@http-util/status-i18n
[coveralls-image]: https://img.shields.io/coveralls/http-util/status-i18n.svg
[coveralls-url]: https://coveralls.io/github/http-util/status-i18n?branch=master
[downloads-image]: https://img.shields.io/npm/dm/@http-util/status-i18n.svg
[downloads-url]: https://npmjs.org/package/@http-util/status-i18n