Logo for jsDocs.io

@types/content-disposition

  • Version 0.5.8
  • Published
  • 6.48 kB
  • No dependencies
  • MIT license

Install

npm i @types/content-disposition
yarn add @types/content-disposition
pnpm add @types/content-disposition

Overview

TypeScript definitions for content-disposition

Index

Functions

Interfaces

Functions

function contentDisposition

contentDisposition: typeof contentDisposition;

  • Create an attachment Content-Disposition header value using the given file name, if supplied. The filename is optional and if no file name is desired, but you want to specify options, set filename to undefined.

function parse

parse: (contentDispositionHeader: string) => ContentDisposition;

  • Parse a Content-Disposition header string

Interfaces

interface ContentDisposition

interface ContentDisposition {}

  • Class for parsed Content-Disposition header for v8 optimization

property parameters

parameters: { [key: string]: string };

  • An object of the parameters in the disposition (name of parameter always lower case and extended versions replace non-extended versions)

property type

type: 'attachment' | 'inline' | string;

  • The disposition type (always lower case)

interface Options

interface Options {}

    property fallback

    fallback?: string | boolean | undefined;

    • If the filename option is outside ISO-8859-1, then the file name is actually stored in a supplemental field for clients that support Unicode file names and a ISO-8859-1 version of the file name is automatically generated true

    property type

    type?: 'attachment' | 'inline' | string | undefined;

    • Specifies the disposition type. This can also be "inline", or any other value (all values except inline are treated like attachment, but can convey additional information if both parties agree to it). The type is normalized to lower-case. 'attachment'

    Package Files (1)

    Dependencies (0)

    No dependencies.

    Dev Dependencies (0)

    No dev dependencies.

    Peer Dependencies (0)

    No peer dependencies.

    Badge

    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/content-disposition.

    • Markdown
      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/content-disposition)
    • HTML
      <a href="https://www.jsdocs.io/package/@types/content-disposition"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>