UNPKG

content-types-lite

Version:

A collection of common CONTENT types for use in applications.

8 lines (7 loc) 10.7 kB
{ "version": 3, "sources": ["../../src/index.ts"], "sourcesContent": ["/**\r\n * @fileoverview Defines the various content types used in the application.\r\n * This module exports an object that contains different content types\r\n * the application commonly handles. These content types are used to\r\n * specify the nature of the content being transmitted.\r\n *\r\n * @module constants/contentTypesLite.ts\r\n * @version 1.2.0\r\n * @license CC BY-NC-ND 4.0\r\n *\r\n * @contact Mohammad Montasim -Al- Mamun Shuvo\r\n * @created 2025-01-29\r\n * @contactEmail montasimmamun@gmail.com\r\n * @contactGithub https://github.com/montasim\r\n */\r\n\r\n/**\r\n * An object representing different content types.\r\n * @enum {string}\r\n */\r\nconst contentTypesLite = Object.freeze({\r\n /** Text-Based Content Types */\r\n\r\n /** Plain text format.\r\n * Example: `.txt` files.\r\n * Use Case: Simple text files without any formatting.\r\n */\r\n PLAIN_TEXT: 'text/plain' as const,\r\n\r\n /** HyperText Markup Language.\r\n * Example: `.html` files.\r\n * Use Case: Web pages and web applications.\r\n */\r\n HTML: 'text/html' as const,\r\n\r\n /** Cascading Style Sheets.\r\n * Example: `.css` files.\r\n * Use Case: Styling web pages.\r\n */\r\n CSS: 'text/css' as const,\r\n\r\n /** Comma-separated values format.\r\n * Example: `.csv` files.\r\n * Use Case: Data exchange between applications, especially spreadsheets.\r\n */\r\n CSV: 'text/csv' as const,\r\n\r\n /** Extensible Markup Language.\r\n * Example: `.xml` files.\r\n * Use Case: Data representation and transfer.\r\n */\r\n XML: 'text/xml' as const,\r\n\r\n /** Markdown text format.\r\n * Example: `.md` files.\r\n * Use Case: Writing formatted text using a plain text editor.\r\n */\r\n MARKDOWN: 'text/markdown' as const,\r\n\r\n /** Rich Text Format.\r\n * Example: `.rtf` files.\r\n * Use Case: Text documents with simple formatting.\r\n */\r\n RICH_TEXT: 'text/richtext' as const,\r\n\r\n /** Structured Data Formats */\r\n\r\n /** JSON format.\r\n * Example: `.json` files.\r\n * Use Case: Data interchange between web applications and servers.\r\n */\r\n JSON: 'application/json' as const,\r\n\r\n /** XML format for application data.\r\n * Example: `.xml` API responses.\r\n * Use Case: Data interchange in web services.\r\n */\r\n XML_APP: 'application/xml' as const,\r\n\r\n /** YAML Ain't Markup Language.\r\n * Example: `.yaml` files.\r\n * Use Case: Configuration files and data serialization.\r\n */\r\n YAML: 'application/x-yaml' as const,\r\n\r\n /** URL-encoded form data.\r\n * Example: query strings in `application/x-www-form-urlencoded`.\r\n * Use Case: Form submissions in web applications.\r\n */\r\n FORM_URLENCODED: 'application/x-www-form-urlencoded' as const,\r\n\r\n /** Newline-delimited JSON, used in streaming APIs.\r\n * Example: `.ndjson` for batch API requests.\r\n * Use Case: Streaming large datasets.\r\n */\r\n NDJSON: 'application/x-ndjson' as const,\r\n\r\n /** MessagePack format, used for efficient binary serialization.\r\n * Example: `.msgpack` files.\r\n * Use Case: Efficient data interchange.\r\n */\r\n MSGPACK: 'application/x-msgpack' as const,\r\n\r\n /** Protocol Buffers, used in Google's data interchange format.\r\n * Example: `.proto` files.\r\n * Use Case: Efficient data serialization.\r\n */\r\n PROTOBUF: 'application/x-protobuf' as const,\r\n\r\n /** Multipart & Form Data */\r\n\r\n /** Multipart form data.\r\n * Used in file uploads.\r\n * Use Case: Uploading files via web forms.\r\n */\r\n MULTIPART_FORM_DATA: 'multipart/form-data' as const,\r\n\r\n /** Multipart mixed content.\r\n * Used to combine different content types in emails and APIs.\r\n * Use Case: Sending emails with attachments.\r\n */\r\n MULTIPART_MIXED: 'multipart/mixed' as const,\r\n\r\n /** Alternative representations of the same content.\r\n * Example: multipart emails.\r\n * Use Case: Sending emails with different content types.\r\n */\r\n MULTIPART_ALTERNATIVE: 'multipart/alternative' as const,\r\n\r\n /** Digest-multipart format.\r\n * Used for secure email digests.\r\n * Use Case: Sending secure email digests.\r\n */\r\n MULTIPART_DIGEST: 'multipart/digest' as const,\r\n\r\n /** Related multipart format.\r\n * Used in web services and APIs.\r\n * Use Case: Sending related content in web services.\r\n */\r\n MULTIPART_RELATED: 'multipart/related' as const,\r\n\r\n /** Signed multipart data.\r\n * Used in digital signatures.\r\n * Use Case: Sending digitally signed content.\r\n */\r\n MULTIPART_SIGNED: 'multipart/signed' as const,\r\n\r\n /** Encrypted multipart data.\r\n * Used for secure messaging.\r\n * Use Case: Sending encrypted content.\r\n */\r\n MULTIPART_ENCRYPTED: 'multipart/encrypted' as const,\r\n\r\n /** Binary & File Upload Content Types */\r\n\r\n /** Generic binary data.\r\n * Used for raw file uploads.\r\n * Use Case: Uploading binary files.\r\n */\r\n OCTET_STREAM: 'application/octet-stream' as const,\r\n\r\n /** Portable Document Format.\r\n * Example: `.pdf` files.\r\n * Use Case: Document exchange.\r\n */\r\n PDF: 'application/pdf' as const,\r\n\r\n /** ZIP compressed file.\r\n * Example: `.zip` files.\r\n * Use Case: Compressing multiple files.\r\n */\r\n ZIP: 'application/zip' as const,\r\n\r\n /** Gzip compressed file.\r\n * Example: `.gz` files.\r\n * Use Case: Compressing single files.\r\n */\r\n GZIP: 'application/gzip' as const,\r\n\r\n /** Microsoft Word document.\r\n * Example: `.doc` files.\r\n * Use Case: Word processing documents.\r\n */\r\n MSWORD: 'application/msword' as const,\r\n\r\n /** Microsoft Word (XML format).\r\n * Example: `.docx` files.\r\n * Use Case: Word processing documents.\r\n */\r\n DOCX: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' as const,\r\n\r\n /** Microsoft Excel spreadsheet.\r\n * Example: `.xls` files.\r\n * Use Case: Spreadsheet documents.\r\n */\r\n EXCEL: 'application/vnd.ms-excel' as const,\r\n\r\n /** Microsoft Excel (XML format).\r\n * Example: `.xlsx` files.\r\n * Use Case: Spreadsheet documents.\r\n */\r\n XLSX: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' as const,\r\n\r\n /** Microsoft PowerPoint presentation.\r\n * Example: `.ppt` files.\r\n * Use Case: Presentation documents.\r\n */\r\n POWERPOINT: 'application/vnd.ms-powerpoint' as const,\r\n\r\n /** Microsoft PowerPoint (XML format).\r\n * Example: `.pptx` files.\r\n * Use Case: Presentation documents.\r\n */\r\n PPTX: 'application/vnd.openxmlformats-officedocument.presentationml.presentation' as const,\r\n\r\n /** Media Content Types */\r\n\r\n /** GIF image format.\r\n * Example: `.gif` files.\r\n * Use Case: Animated images.\r\n */\r\n GIF: 'image/gif' as const,\r\n\r\n /** PNG image format.\r\n * Example: `.png` files.\r\n * Use Case: Lossless image compression.\r\n */\r\n PNG: 'image/png' as const,\r\n\r\n /** JPEG image format.\r\n * Example: `.jpg`, `.jpeg` files.\r\n * Use Case: Lossy image compression.\r\n */\r\n JPEG: 'image/jpeg' as const,\r\n\r\n /** WebP image format.\r\n * Example: `.webp` files.\r\n * Use Case: Modern image format with both lossy and lossless compression.\r\n */\r\n WEBP: 'image/webp' as const,\r\n\r\n /** Scalable Vector Graphics.\r\n * Example: `.svg` files.\r\n * Use Case: Vector images.\r\n */\r\n SVG: 'image/svg+xml' as const,\r\n\r\n /** High-Efficiency Image Format.\r\n * Example: `.heif` files.\r\n * Use Case: High-efficiency image compression.\r\n */\r\n HEIF: 'image/heif' as const,\r\n\r\n /** AVIF image format.\r\n * Example: `.avif` files.\r\n * Use Case: High-efficiency image compression.\r\n */\r\n AVIF: 'image/avif' as const,\r\n\r\n /** Streaming & Event Content Types */\r\n\r\n /** Server-Sent Events streaming format.\r\n * Example: `.sse` events.\r\n * Use Case: Real-time data streaming.\r\n */\r\n EVENT_STREAM: 'text/event-stream' as const,\r\n\r\n /** TAR archive format.\r\n * Example: `.tar` files.\r\n * Use Case: Archiving multiple files.\r\n */\r\n TAR: 'application/x-tar' as const,\r\n\r\n /** Bzip2 compressed file.\r\n * Example: `.bz2` files.\r\n * Use Case: Compressing single files.\r\n */\r\n BZIP2: 'application/x-bzip2' as const,\r\n});\r\n\r\n/**\r\n * Type definition for available content types.\r\n */\r\nexport type ContentType = keyof typeof contentTypesLite;\r\n\r\nexport default contentTypesLite;\r\n"], "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAoBA,IAAM,mBAAmB,OAAO,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOnC,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA,EAMZ,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,EAMN,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,EAML,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,EAML,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,EAML,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA,EAMV,WAAW;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQX,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,EAMN,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,EAMT,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,EAMN,iBAAiB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMjB,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMR,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,EAMT,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQV,qBAAqB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMrB,iBAAiB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMjB,uBAAuB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMvB,kBAAkB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMlB,mBAAmB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMnB,kBAAkB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMlB,qBAAqB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQrB,cAAc;AAAA;AAAA;AAAA;AAAA;AAAA,EAMd,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,EAML,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,EAML,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,EAMN,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMR,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,EAMN,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA,EAMP,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,EAMN,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA,EAMZ,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQN,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,EAML,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,EAML,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,EAMN,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,EAMN,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,EAML,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,EAMN,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQN,cAAc;AAAA;AAAA;AAAA;AAAA;AAAA,EAMd,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,EAML,OAAO;AACX,CAAC;AAOD,IAAO,gBAAQ;", "names": [] }