@stagas/immutable-list

Immutable list.

npm i @stagas/immutable-list

pnpm add @stagas/immutable-list

yarn add @stagas/immutable-list

Examples

# node

# view source

example/node.ts

import { add } from '@stagas/immutable-list'

console.log(add(1, 2))

# web

# view source

example/web.ts

import { add } from '@stagas/immutable-list'

const main = document.querySelector('main')!

main.innerHTML = `<h1>1 + 2 = ${add(1, 2)}</h1>`

🥁 Use this template 🥁

Features

• TypeScript with SWC
• JSX/TSX out of the box
• Outputs both CommonJS and ES Modules, ready to publish on npm
• Automatic dist bundling using bunzee
• Documentation generation using dokio
• Isomorphic Node.js and real browser testing incl. coverage and snapshots with utr
• Examples / Playground using devito
• Evergreen using pull-configs
• ESLint
• dprint
• Husky

API

# JSONAble

# constructor(data)

# new JSONAble()

JSONAble<T>

# data

any

# onceSymbol

symbol

# emit(eventName, args)

# eventName

K

# args

Parameters<T [K]>

emit<K>(eventName, args)  =>

JSONAble<T>

# off(eventName, callback)

# eventName

K

# callback

T [K]

off<K>(eventName, callback)  =>

undefined | JSONAble<T>

# on(eventName, callback, options)

# eventName

K

# callback

T [K]

# options

EventEmitterOptions

on<K>(eventName, callback, options)  =>

Off

# once(eventName, callback)

# eventName

K

# callback

T [K]

once<K>(eventName, callback)  =>

JSONAble<T>

# toJSON(this)

# this

JSONAble<T>

toJSON(this)  =>

Partial<JSONAble<T>>

# List

# constructor(data)

# new List()

List<T, R>

# data  =  {}

Partial<List<T, Record<string, any>>>

# ctor

Class<List<T, R>>

# items  =  []

T []

# onceSymbol

symbol

# add(item)

# item

T

add(item)  =>

List<T, R> & Partial<List<T, R>> & {
# items  =  ...

T []

}

# emit(eventName, args)

# eventName

K

# args

Parameters<R [K]>

emit<K>(eventName, args)  =>

List<T, R>

# equals(other)

# other

List<T, Record<string, any>>

equals(other)  =>

boolean

# getById(itemId)

# itemId

string | false

getById<U extends  ListItem>(itemId)  =>

U

# hasId(itemId)

# itemId

string

hasId(itemId)  =>

boolean

# insertAfterIndex(index, newItem)

# index

number

# newItem

T

insertAfterIndex(index, newItem)  =>

List<T, R> & Partial<List<T, R>> & {
# items  =  ...

T []

}

# insertAt(index, newItem)

# index

number

# newItem

T

insertAt(index, newItem)  =>

List<T, R> & Partial<List<T, R>> & {
# items  =  ...

T []

}

# mergeEach(data)

# data

Partial<T>

mergeEach(data)  =>

List<T, R>

# off(eventName, callback)

# eventName

K

# callback

R [K]

off<K>(eventName, callback)  =>

undefined | List<T, R>

# on(eventName, callback, options)

# eventName

K

# callback

R [K]

# options

EventEmitterOptions

on<K>(eventName, callback, options)  =>

Off

# once(eventName, callback)

# eventName

K

# callback

R [K]

once<K>(eventName, callback)  =>

List<T, R>

# removeById(itemId)

# itemId

string

removeById(itemId)  =>

List<T, R> & Partial<List<T, R>> & {
# items  =  ...

T []

}

# setById(itemId, newItem)

# itemId

string

# newItem

U

setById<U extends  ListItem>(itemId, newItem)  =>

List<T, R>

# toJSON(this)

# this

List<T, R>

toJSON(this)  =>

Partial<List<T, R>>

# updateById(itemId, updateData)

# itemId

string

# updateData

Partial<U>

updateById<U extends  ListItem>(itemId, updateData)  =>

List<T, R>

# ListItem

object & {

# id

string

}

# createOrReturn(ctor, prev, key, next)

# ctor

TCtor

# prev

T

# key

TKey

# next

T [TKey]

createOrReturn<T extends  JSONAble<Record<string, any>, T>, TKey, TCtor extends  Class<T>>(ctor, prev, key, next)  =>

T

# getItemInListById(list, itemId)

# list

T []

# itemId

string | false

getItemInListById<T extends  ListItem>(list, itemId)  =>

T

# insertItemInListAtIndex(list, index, newItem)

# list

T []

# index

number

# newItem

T

insertItemInListAtIndex<T extends  ListItem>(list, index, newItem)  =>

T []

# removeItemInListById(list, itemId)

# list

T []

# itemId

string

removeItemInListById<T extends  ListItem>(list, itemId)  =>

T []

# setItemInListById(list, itemId, newItem)

# list

T []

# itemId

string

# newItem

T

setItemInListById<T extends  ListItem>(list, itemId, newItem)  =>

T []

# updateItemInListById(list, itemId, updateData)

# list

T []

# itemId

string

# updateData

Partial<T>

updateItemInListById<T extends  ListItem>(list, itemId, updateData)  =>

any []

# updateOrReturn(target, updateData)

# target

T

# updateData

Partial<T>

updateOrReturn<T>(target, updateData)  =>

any

Credits

• everyday-types by stagas – Everyday utility types
• everyday-utils by stagas – Everyday utilities

Contributing

Fork or edit and submit a PR.

All contributions are welcome!

License

MIT © 2022 stagas