diff --git a/.github/.stale.yml b/.github/.stale.yml deleted file mode 100644 index 2ee1269..0000000 --- a/.github/.stale.yml +++ /dev/null @@ -1,21 +0,0 @@ -# Number of days of inactivity before an issue becomes stale -daysUntilStale: 15 -# Number of days of inactivity before a stale issue is closed -daysUntilClose: 7 -# Issues with these labels will never be considered stale -exemptLabels: - - "discussion" - - "feature request" - - "bug" - - "help wanted" - - "plugin suggestion" - - "good first issue" -# Label to use when marking an issue as stale -staleLabel: stale -# Comment to post when marking an issue as stale. Set to `false` to disable -markComment: > - This issue has been automatically marked as stale because it has not had - recent activity. It will be closed if no further activity occurs. Thank you - for your contributions. -# Comment to post when closing a stale issue. Set to `false` to disable -closeComment: false \ No newline at end of file diff --git a/.github/tests_checker.yml b/.github/tests_checker.yml deleted file mode 100644 index 769469b..0000000 --- a/.github/tests_checker.yml +++ /dev/null @@ -1,8 +0,0 @@ -comment: | - Hello! Thank you for contributing! - It appears that you have changed the code, but the tests that verify your change are missing. Could you please add them? -fileExtensions: - - '.ts' - - '.js' - -testDir: 'test' \ No newline at end of file diff --git a/README.md b/README.md index e613e0e..0c0efda 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,17 @@ # fast-content-type-parse -
- [![NPM version](https://img.shields.io/npm/v/fast-content-type-parse.svg?style=flat)](https://www.npmjs.com/package/fast-content-type-parse) [![NPM downloads](https://img.shields.io/npm/dm/fast-content-type-parse.svg?style=flat)](https://www.npmjs.com/package/fast-content-type-parse) [![CI](https://github.com/fastify/fast-content-type-parse/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/fastify/fast-content-type-parse/actions/workflows/ci.yml) [![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard) [![Security Responsible Disclosure](https://img.shields.io/badge/Security-Responsible%20Disclosure-yellow.svg)](https://github.com/fastify/.github/blob/main/SECURITY.md) -
- Parse HTTP Content-Type header according to RFC 7231. ## Installation ```sh -$ npm install fast-content-type-parse +npm install fast-content-type-parse ``` ## Usage @@ -35,10 +31,10 @@ Parse a `Content-Type` header. Throws a `TypeError` if the string is invalid. It will return an object with the following properties (examples are shown for the string `'application/json; charset=utf-8'`): - - `type`: The media type (the type and subtype, always lowercase). +- `type`: The media type (the type and subtype, always lowercase). Example: `'application/json'` - - `parameters`: An object of the parameters in the media type (name of parameter +- `parameters`: An object of the parameters in the media type (name of parameter always lowercase). Example: `{charset: 'utf-8'}` ### fastContentTypeParse.safeParse(string) @@ -52,10 +48,10 @@ Parse a `Content-Type` header. It will not throw an Error if the header is inval This will return an object with the following properties (examples are shown for the string `'application/json; charset=utf-8'`): - - `type`: The media type (the type and subtype, always lowercase). +- `type`: The media type (the type and subtype, always lowercase). Example: `'application/json'` - - `parameters`: An object of the parameters in the media type (name of parameter +- `parameters`: An object of the parameters in the media type (name of parameter always lowercase). Example: `{charset: 'utf-8'}` In case the header is invalid, it will return an object