Skip to content

Quick Start

Installation

bash
npm install @duplojs/utils
bash
yarn add @duplojs/utils
bash
pnpm add @duplojs/utils

Configuration

Start by setting the right options in your tsconfig.

json
{
	// ...
	"compilerOptions": {
		// ...
		"strict": true,
		"noImplicitAny": true,
		"strictNullChecks": true,
		"strictFunctionTypes": true,
		"strictBindCallApply": true,
		"strictPropertyInitialization": true,
		"noImplicitThis": true,
		"useUnknownInCatchVariables": true,
		"alwaysStrict": true,
		"noImplicitReturns": true,
		"noUncheckedIndexedAccess": true,
		"noImplicitOverride": true
	}
}

Library organization

The library is organized by domains:

  • Common General-purpose functions not tied to a specific type.
  • Array Functions for arrays and tuples.
  • Clean Tools for defining business structures.
  • DataParser Data validation schema creation.
  • Date Date manipulation utilities.
  • Either Result definition tools.
  • Generator Helpers for iterables with generators.
  • Number Number utilities.
  • Object Object utilities.
  • Pattern Pattern matching tools.
  • String String utilities.

Import paths

All modules can be imported from the root.

ts
import { A, C, DPE, D, E, G, N, O, P, S, /* ...common */ } from "@duplojs/utils";

Tree-shaking

You can import different parts of the library like this to optimize your build:

ts
import * as Common from "@duplojs/utils/common";
import * as A from "@duplojs/utils/array";
import * as C from "@duplojs/utils/clean";
import * as DP from "@duplojs/utils/dataParser";
import * as D from "@duplojs/utils/date";
import * as E from "@duplojs/utils/either";
import * as G from "@duplojs/utils/generator";
import * as N from "@duplojs/utils/number";
import * as O from "@duplojs/utils/object";
import * as P from "@duplojs/utils/pattern";
import * as S from "@duplojs/utils/string";

Enjoy!

Released under the MIT license.