Socket
Socket
Sign inDemoInstall

@tinyhttp/content-type

Package Overview
Dependencies
0
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @tinyhttp/content-type

content-type rewrite in TypeScript and ESM


Version published
Maintainers
1
Created

Readme

Source

@tinyhttp/content-type

Version Downloads GitHub Workflow Status Codecov

content-type rewrite in TypeScript and ESM.

Create and parse HTTP Content-Type header according to RFC 7231

Install

pnpm i @tinyhttp/content-type

API

import { parse, format } from '@tinyhttp/content-type'

parse(string: string | Request | Response)

const obj = parse('image/svg+xml; charset=utf-8')

Parse a Content-Type header. This will return an object with the following properties (examples are shown for the string 'image/svg+xml; charset=utf-8'):

  • type: The media type (the type and subtype, always lower case). Example: 'image/svg+xml'

  • parameters: An object of the parameters in the media type (name of parameter always lower case). Example: {charset: 'utf-8'}

Throws a TypeError if the string is missing or invalid.

const obj = contentType.parse(req)

Parse the Content-Type header from the given req. Short-cut for contentType.parse(req.headers['content-type']).

Throws a TypeError if the Content-Type header is missing or invalid.

const obj = contentType.parse(res)

Parse the Content-Type header set on the given res. Short-cut for contentType.parse(res.getHeader('content-type')).

Throws a TypeError if the Content-Type header is missing or invalid.

format(obj)

const str = contentType.format({
  type: 'image/svg+xml',
  parameters: { charset: 'utf-8' },
})

Format an object into a Content-Type header. This will return a string of the content type for the given object with the following properties (examples are shown that produce the string 'image/svg+xml; charset=utf-8'):

  • type: The media type (will be lower-cased). Example: 'image/svg+xml'

  • parameters: An object of the parameters in the media type (name of the parameter will be lower-cased). Example: {charset: 'utf-8'}

Throws a TypeError if the object contains an invalid type or parameter names.

FAQs

Last updated on 28 Sep 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc