everyday-types

everyday-types

Everyday utility types

npm i everyday-types

pnpm add everyday-types

yarn add everyday-types

API

#

# AAt

src/string.ts#L3

A extends List ? number extends A ["length"] ? K extends number | template-literal ? A [never] | undefined : undefined : K extends keyof A ? A [K] : undefined : unknown extends A ? unknown : K extends keyof A ? A [K] : undefined

# Cast

src/string.ts#L42

A1 extends A2 ? A1 : A2

# Key

src/string.ts#L1

string | number | symbol

# LLength – Ask TS to re-check that A1 extends A2. And if it fails, A2 will be enforced anyway. Can also be used to add constraints on parameters.

src/string.ts#L40

L ["length"]

# List

src/string.ts#L2

ReadonlyArray<A>

# Literal

src/string.ts#L11

string | number | bigint | boolean

# Pop

src/string.ts#L63

L extends readonly tuple | readonly tuple ? LBody : L

# _Replace

src/string.ts#L47

S extends template-literal ? Replace<template-literal, R, W> : S

# __Split

src/string.ts#L50

S extends template-literal ? __Split<AS, D, tuple> : tuple

# String

src/string.ts#L1

# At

src/string.ts#L10

AAt<Split<S, "">, K>

# Join – Concat many literals together

src/string.ts#L24

_Join<T, D> extends inferred ? Cast<X, string> : never

# Length

src/string.ts#L43

LLength<Split<S, "">>

# Replace

src/string.ts#L44

_Replace<S, R, W> extends inferred ? Cast<X, string> : never

# Split – Split S by D into a [[List]]

src/string.ts#L62

_Split<S, D> extends inferred ? Cast<X, string []> : never

# EventHandler

src/everyday-types.ts#L7

# this

T

# event

E & {

# currentTarget

src/everyday-types.ts#L8

T

EventHandler(this, event)  =>

# Chunk

src/everyday-types.ts#L3

N extends N ? number extends N ? T [] : _Chunk<T, N, tuple> : never

# Class

src/everyday-types.ts#L5

# (args)

src/everyday-types.ts#L5

# new()

T

# args

any []

# Ctor

src/everyday-types.ts#L6

# (args)

src/everyday-types.ts#L6

# new()

unknown

# args

any []

# DetailOf

src/everyday-types.ts#L52

Narrow<Parameters<Narrow<Get<T, K>, Fn<any, any>>> [0], CustomEvent> ["detail"]

# EventKeys

src/everyday-types.ts#L10

keyof EventsOf<T>

# EventsOf

src/everyday-types.ts#L31

[K in Keys<T> ]-?: Narrow<Parameters<Narrow<Get<T, K>, Fn<any, any>>> [0], Event>

# Fn

src/everyday-types.ts#L11

# (args)

# args

T

(args)  =>

R

# Get

src/everyday-types.ts#L12

T [NarrowKey<K, T>]

# Key

src/everyday-types.ts#L13

number | string | symbol

# Keys

src/everyday-types.ts#L14

keyof [K in keyof T ]: StringOf<K>

# Mixable

src/everyday-types.ts#L15

{} & Omit<T, "constructor">

# Narrow

src/everyday-types.ts#L17

K extends T ? K : never

# NarrowKey

src/everyday-types.ts#L16

Narrow<K, keyof T>

# NonNull

src/everyday-types.ts#L18

[K in Keys<T> ]: T [K]

# Null

src/everyday-types.ts#L19

null | undefined | void

# ObjectFromList

src/everyday-types.ts#L21

[K in T extends ReadonlyArray<inferred> ? U : never ]: V

# Prefix

src/everyday-types.ts#L24

template-literal

# SansOn

src/everyday-types.ts#L25

String.Split<StringOf<T>, " on">

# StringLiteral

src/everyday-types.ts#L26

T extends string ? string extends T ? never : T : never

# StringOf

src/everyday-types.ts#L27

Narrow<T, string>

# Target

src/everyday-types.ts#L28

HTMLElement | SVGElement | Window | Document | ShadowRoot

# ValuesOf

src/everyday-types.ts#L29

T [keyof T]

# _Chunk

src/everyday-types.ts#L4

R ["length"] extends N ? R : _Chunk<T, N, tuple>

Credits

• ts-toolbelt by Pierre-Antoine Mills – TypeScript's largest utility library

Contributing

Fork or edit and submit a PR.

All contributions are welcome!

License

MIT © 2022 stagas