1.2.0 • Published 8 months ago

http-utils-kit v1.2.0

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

HTTP Utils Kit

A comprehensive and lightweight TypeScript/JavaScript library for HTTP-related constants and utilities.

Features

  • Complete HTTP standards compliance (RFC 7231, 7232, 7233, 7234, 7235)
  • Full TypeScript support with proper type definitions
  • Zero dependencies
  • CommonJS and ES Module support
  • Comprehensive constant coverage:
    • HTTP status codes with messages
    • HTTP methods (including WebDAV)
    • HTTP headers (standard, CORS, security, rate limiting)
    • Content types (MIME types)
    • URL schemes
    • Cache control directives
  • Utility functions for common HTTP operations

Installation

npm install http-utils-kit
# or
yarn add http-utils-kit
# or
pnpm add http-utils-kit

Usage

TypeScript / ES Modules

import { 
  HTTP_STATUS,
  HTTP_STATUS_MESSAGE,
  HTTP_METHODS,
  HTTP_HEADERS,
  CONTENT_TYPES,
  CookieUtils,
  AuthUtils 
} from 'http-utils-kit';

// Status codes
console.log(HTTP_STATUS.OK);                    // 200
console.log(HTTP_STATUS_MESSAGE.OK);            // 'OK'

// HTTP Methods
console.log(HTTP_METHODS.GET);                  // 'GET'
console.log(HTTP_METHODS.POST);                 // 'POST'

// Auth
const token = AuthUtils.extractBearerToken('Bearer abc123');
console.log(token);                            // 'abc123'

JavaScript (CommonJS)

const { 
  HTTP_STATUS,
  HTTP_METHODS
} = require('http-utils-kit');

API Reference

Constants

HTTP_STATUS

Standard HTTP status codes

HTTP_STATUS.OK                  // 200
HTTP_STATUS.NOT_FOUND          // 404
HTTP_STATUS.INTERNAL_SERVER_ERROR // 500

HTTP_STATUS_MESSAGE

Status code messages

HTTP_STATUS_MESSAGE.OK         // 'OK'
HTTP_STATUS_MESSAGE.NOT_FOUND  // 'Not Found'

HTTP_METHODS

HTTP methods including WebDAV

HTTP_METHODS.GET              // 'GET'
HTTP_METHODS.POST             // 'POST'
HTTP_METHODS.PATCH            // 'PATCH'
HTTP_METHODS.LOCK            // 'LOCK' (WebDAV)

HTTP_HEADERS

Standard HTTP headers

HTTP_HEADERS.CONTENT_TYPE    // 'Content-Type'
HTTP_HEADERS.AUTHORIZATION   // 'Authorization'

CONTENT_TYPES

MIME types

CONTENT_TYPES.APPLICATION_JSON  // 'application/json'
CONTENT_TYPES.TEXT_HTML        // 'text/html'

Utilities

AuthUtils

AuthUtils.extractBearerToken('Bearer token123')  // 'token123'
AuthUtils.createBearerToken('token123')         // 'Bearer token123'

TypeScript Support

The library includes comprehensive TypeScript definitions and provides type safety for all constants and utilities.

import { HttpStatusCode, HttpMethod, HttpHeader } from 'http-utils-kit';

const status: HttpStatusCode = HTTP_STATUS.OK;
const method: HttpMethod = HTTP_METHODS.GET;
const header: HttpHeader = HTTP_HEADERS.CONTENT_TYPE;

License

MIT

Contributing and Publishing

See PUBLISHING.md for detailed instructions on how to publish new versions and contribute to the project.