@snailicid3/types 🐌

Pure TypeScript types, utility types, and typeguard functions.

Repository

• Github: @snailicid3/types • snailicid3
• CDN: jsdeliver

Author

👤 Gillian Tunney

• github
• email

Recommended package manager is pnpm

@snailicid3/types 🐌

This package provides foundational TypeScript type definitions, utility types, and runtime typeguard functions. It has no runtime dependencies beyond ramda and type-fest and is safe to use in any environment.

@snailicid3/types contains:

• Utility types — Falsy, NilOrEmpty, NilLike, Nullish, Primitive, PlainObject, EmptyString and more
• JSON types — typed JSON value, object, and array types
• Typeguards — tg.isTruthy, tg.isFalsy, tg.isNilOrEmpty, tg.isNotNilOrEmpty, tg.guardToAssertion, tg.predicateToAssertion

Installation

#pnpm
$ pnpm add @snailicid3/types

#yarn
$ yarn add @snailicid3/types

#npm
$ npm install @snailicid3/types

Examples

Typeguards

import { tg } from '@snailicid3/types'

tg.isTruthy(0) // false
tg.isTruthy('hello') // true

tg.isNilOrEmpty(null) // true
tg.isNilOrEmpty([]) // true
tg.isNilOrEmpty([1]) // false

const assertIsString = tg.guardToAssertion(
  (v: unknown): v is string => typeof v === 'string',
)
assertIsString('ok') // passes
assertIsString(42) // throws TypeError