Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions Library/Typings.d.ts
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@

declare module 'accept-language' {

declare module "accept-language" {
interface AcceptLanguage {

/**
* Define your supported languages. The first language will be your default language.
*/
languages(languages: string[]): void;

/**
* Sets default//fallback languages. If not called - then defaults language will be languages[0], which were set via languages(...) method.
*/
setDefaultLanguageTag(defaultLanguageTag: string | null): void;

/**
* Get matched language. If no match, the default language will be returned.
*/
get(priorityList: string | null | undefined): string | null;
}

interface AcceptLanguageModule extends AcceptLanguage {

/**
* Create instance of parser
*/
Expand Down
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
accept-language [![Build Status](https://travis-ci.org/tinganho/node-accept-language.png)](https://travis-ci.org/tinganho/node-accept-language)
========================
# accept-language [![Build Status](https://travis-ci.org/tinganho/node-accept-language.png)](https://travis-ci.org/tinganho/node-accept-language)

[![NPM](https://nodei.co/npm/accept-language.png?downloads=true&stars=true)](https://nodei.co/npm/accept-language/)

Expand All @@ -15,9 +14,12 @@ npm install accept-language --save

```ts
// var acceptLanguage = require('accept-language');
import acceptLanguage from 'accept-language';
acceptLanguage.languages(['en-US', 'zh-CN']);
console.log(acceptLanguage.get('en-GB,en;q=0.8,sv'));
import acceptLanguage from "accept-language";
acceptLanguage.languages(["en-US", "zh-CN"]);
// default language will be first from lang tags, given to languages(...) method.
// But if you dont want that behavior - uncomment following line
//acceptLanguage.setDefaultLanguageTag(null);
console.log(acceptLanguage.get("en-GB,en;q=0.8,sv"));
/*

'en-US'
Expand All @@ -26,27 +28,33 @@ console.log(acceptLanguage.get('en-GB,en;q=0.8,sv'));
```

### Usage with Express:

If you are using Express server please use the middleware [express-request-language](https://www.npmjs.com/package/express-request-language).

### API

#### acceptLanguage.languages(Array languageTags);

Provide your language tags in order of priority. The language tags must comply with [BCP47][] standard.

```javascript
acceptLanguage.languages(['en-US', 'zh-CN']);
acceptLanguage.languages(["en-US", "zh-CN"]);
```

#### acceptLanguage.get(String acceptLanguageString);

Returns the most likely language given an `Accept-Language` string. At least 1 language tag must be provided.

```javascript
acceptLanguage.get('en-GB,en;q=0.8,sv');
acceptLanguage.get("en-GB,en;q=0.8,sv");
```

### Maintainer

Tingan Ho [@tingan87][]

### License

MIT

[L10ns]: http://l10ns.org
Expand Down
Loading