Skip to content

skn437/skn-web-utils

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

7 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

SKN Web Utils

Web Utils

TypeScript

NPM Version MIT License

Β 

Introduction:

A simple library consisting some web development utility objects

I mainly created this library so that I can use it in many web developing projects without duplicating codes

Β 

Features:

  • πŸ’₯ HTTP Method Containing Object Cursor Just Like Java Spring Boot
  • ✨ HTTP Response Status Code Containing Object
  • πŸ“œ HTML lang Attribute Value Containing Object
  • πŸ“‘ HTTP Method Type Which Will Ensure Type Safety For Valid HTTP Methods
  • πŸ“š Information Regarding The Object Properties On Mouse Hover

Β 

Details:

httpMethod Object

  • It contains the available HTTP Method names as string
  • Java has similar Enum called HttpMethod in org.springframework.http package
  • Get all the available HTTP Methods without looking at elsewhere
  • Hover over the properties to get the information on the method
  • You need not go search on google to find out which method does what
  • For usage instruction, see Usage section

httpResponse Object

  • It contains the available HTTP Response Status Codes as number
  • Get all the available HTTP Response Status Codes without looking at elsewhere
  • Hover over the properties to get the information on the status codes
  • You need not go search on google to find out which staus code means what
  • For usage instruction, see Usage section

htmlLanguage Object

  • It contains the available values for languages of HTML lang attribute
  • Get all the available HTML lang attribute values without looking at elsewhere
  • You need not go search on google to find out the languages
  • For usage instruction, see Usage section

HttpMethod Type

  • It has all the valid values of HTTP methods
  • For usage instruction, see Usage section

Β 

Use Case:

  • Any JS, TS, Node Project

Β 

Requirements:

This library can be used in any JS/TS project as it has some objects only

Β 

Usage:

To install the package, type the following in console

npm add @best-skn/web-utils
#or
yarn add @best-skn/web-utils
#or
pnpm add @best-skn/web-utils
#or
bun add @best-skn/web-utils

You can use the library as showing below (Just an example)

For httpMethod Object

import { httpMethod } from "@best-skn/web-utils";

export const allowedMethods = [httpMethod.GET, httpMethod.POST, httpMethod.DELETE];

For httpResponse Object

import { httpResponse } from "@best-skn/web-utils";

export const allowedCodes = [httpResponse._200, httpResponse._404, httpResponse._403];

For htmlLanguage Object

import { htmlLanguage } from "@best-skn/web-utils";

const Home = () => (
  <html lang={htmlLanguage.ITALIAN}>
    {!-- Rest of the codes --}
  </html>
);

export default Home;

For HttpMethod Type

import type { HttpMethod } from "@best-skn/web-utils";

const someFunction = (arg: HttpMethod) => {
  // Some Logic Here
};

// You'll get type safe valid HTTP Method suggestions here
someFunction("GET");

Β 

Dedicated To:

  • πŸ‘©β€πŸŽ¨Prodipta Das Logno & πŸ§›β€β™€οΈAtoshi Sarker Prithula: The two most special ladies of my life. My best wishes will always be with you two. May you two always be happy.
  • πŸ’―My Parents: The greatest treasures of my life ever.

Β 

License:

Copyright (C) 2024 SKN Shukhan

Licensed under the MIT License

About

A simple library containing some web development utility objects

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors