is-safari-order/README.md

Checks if http header order is Safari

# is-safari-order

```
Checks if http header order is Safari
```

## Usage

```javascript
const express = require("express");
const isSafariOrder = require("is-safari-order");

const port = 3000;
const app = express();

app.get("/", ({ headers }, res) => {
  const are = isSafariOrder(headers) ? "are" : "are not";

  res.send(`You ${are} safari!`);
});

app.listen(port);
```

# API

```javascript
  type Headers = Record<string, string> | string[] | Array<[string, string]>;
  type IsSafariOrderOptions = {
    areRawHeaders: boolean;
  };

  function isSafariOrder(
    headers: Headers,
    options: IsSafariOrderOptions = { areRawHeaders = false }
  ): boolean;

  export = isSafariOrder;
```

`headers` - one of:

- array of strings

```javascript
["accept", "accept-language"];
```

- object of structure `[key: string]: string`

```javascript
{
  'accept': '...',
  'user-agent': '...'
}
```

- array with 2-length array of strings

```javascript
[
  ["accept-encoding", "gzip"],
  ["accept", "*/*"],
];
```

`options`: object that can have `areRawHeaders` option if it should parse entries array such as:

```javascript
[
  "user-agent",
  "this is invalid because there can be only one",
  "User-Agent",
  "curl/7.22.0",
  "Host",
  "127.0.0.1:8000",
  "ACCEPT",
  "*",
];
```

`areRawHeaders` defaults to `false`

## Test

```bash
npm test
```

## Related repositories

[is-chrome-order](https://github.com/thepicture/is-chrome-order)
[is-firefox-order](https://github.com/thepicture/is-firefox-order)