abstract-presets

Abstract preset manager.

npm i abstract-presets

pnpm add abstract-presets

yarn add abstract-presets

Examples

# node

# view source

example/node.ts

import { add } from 'abstract-presets'

console.log(add(1, 2))

# web

# view source

example/web.ts

import { add } from 'abstract-presets'

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

# AbstractDetail

src/abstract-presets.ts#L31

# constructor(data)

src/abstract-presets.ts#L34

# new AbstractDetail()

AbstractDetail<T>

# data

AbstractDetail<T> | T

# data

src/abstract-presets.ts#L32

T

# copy()
src/abstract-presets.ts#L50
copy()  =>

T

# equals(other)

src/abstract-presets.ts#L43

# other

AbstractDetail<T> | T

equals(other)  =>

boolean

# merge(other)

src/abstract-presets.ts#L42

# other

AbstractDetail<T> | T

merge(other)  =>

any

# satisfies(other)

src/abstract-presets.ts#L44

# other

AbstractDetail<T> | T

satisfies(other)  =>

boolean

# toJSON()

src/abstract-presets.ts#L46

toJSON()  =>

T

# BasePreset

src/abstract-presets.ts#L7

# constructor(data)

src/abstract-presets.ts#L15

# new BasePreset()

BasePreset<T>

# data

Partial<BasePreset<T>>

# detail

src/abstract-presets.ts#L9

T

# id  =  ...

src/abstract-presets.ts#L8

string

# isDraft  =  true

src/abstract-presets.ts#L12

boolean

# isIntent  =  false

src/abstract-presets.ts#L11

boolean

# isRemoved  =  false

src/abstract-presets.ts#L13

boolean

# equals(other)
src/abstract-presets.ts#L19
# other

BasePreset<any>

equals(other)  =>

boolean

# BasePresets

src/abstract-presets.ts#L67

# constructor(data, Preset, Detail)

src/abstract-presets.ts#L75

# new BasePresets()

BasePresets<Detail, Preset, PresetClass>

# data  =  {}

Partial<BasePresets<Detail, Preset, PresetClass>>

# Preset  =  ...

PresetClass

# Detail  =  ...

Class<Detail>

# Detail

src/abstract-presets.ts#L68

Class<Detail>

# Preset

src/abstract-presets.ts#L69

PresetClass

# ctor

Class<BasePresets<Detail, Preset, PresetClass>>

# items

Preset []

# selectedPresetId  =  false

src/abstract-presets.ts#L73

string | false

# spare  =  null
src/abstract-presets.ts#L72
null | {

# index

src/abstract-presets.ts#L72

number

# preset

src/abstract-presets.ts#L72

Preset

}

# onceSymbol

symbol

# selectedPreset

src/abstract-presets.ts#L124

# add(item)

# item

Preset

add(item)  =>

BasePresets<Detail, Preset, PresetClass> & Partial<BasePresets<Detail, Preset, PresetClass>> & {
# items

Preset []

}

# createWithDetail(detail, presetData)

src/abstract-presets.ts#L133

# detail

Detail ["data"]

# presetData  =  {}

Partial<Preset>

createWithDetail(detail, presetData)  =>

Preset

# createWithDetailData(data, presetData)

src/abstract-presets.ts#L137

# data

Detail ["data"]

# presetData

Partial<Preset>

createWithDetailData(data, presetData)  =>

Preset

# emit(eventName, args)

# eventName

K

# args

Parameters<BasePresetsEvents<Preset, Detail> [K]>

emit<K>(eventName, args)  =>

BasePresets<Detail, Preset, PresetClass>

# equals(other)

src/abstract-presets.ts#L111

# other

BasePresets<Detail, Preset, PresetClass>

equals(other)  =>

boolean

# getByDetail(detail)

src/abstract-presets.ts#L163

# detail

Detail

getByDetail(detail)  =>

undefined | Preset

# getById(itemId)

# itemId

string | false

getById<U extends  BasePreset<Detail, U>>(itemId)  =>

U

# hasId(itemId)

# itemId

string

hasId(itemId)  =>

boolean

# insertAfterIndex(index, newItem)

# index

number

# newItem

Preset

insertAfterIndex(index, newItem)  =>

BasePresets<Detail, Preset, PresetClass> & Partial<BasePresets<Detail, Preset, PresetClass>> & {
# items

Preset []

}

# insertAt(index, newPreset)

src/abstract-presets.ts#L175

# index

number

# newPreset

Preset

insertAt(index, newPreset)  =>

BasePresets<Detail, Preset, PresetClass> & Partial<BasePresets<Detail, Preset, PresetClass>> & {
# items

Preset []

}

# mergeEach(data)

# data

Partial<Preset>

mergeEach(data)  =>

BasePresets<Detail, Preset, PresetClass>

# off(eventName, callback)

# eventName

K

# callback

BasePresetsEvents<Preset, Detail> [K]

off<K>(eventName, callback)  =>

undefined | BasePresets<Detail, Preset, PresetClass>

# on(eventName, callback, options)

# eventName

K

# callback

BasePresetsEvents<Preset, Detail> [K]

# options

EventEmitterOptions

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

Off

# once(eventName, callback)

# eventName

K

# callback

BasePresetsEvents<Preset, Detail> [K]

once<K>(eventName, callback)  =>

BasePresets<Detail, Preset, PresetClass>

# removeById(presetId, fallbackPresetId)

src/abstract-presets.ts#L182

# presetId

string

# fallbackPresetId

string

removeById(presetId, fallbackPresetId)  =>

BasePresets<Detail, Preset, PresetClass> & Partial<BasePresets<Detail, Preset, PresetClass>> & {
# items

Preset []

}

# renamePresetRandom(presetId, useEmoji)

src/abstract-presets.ts#L342

# presetId

string

# useEmoji

boolean

renamePresetRandom(presetId, useEmoji)  =>

void

# restoreSpare(newDetail, bySelect)

src/abstract-presets.ts#L141

# newDetail

Detail

# bySelect

boolean

restoreSpare(newDetail, bySelect)  =>

undefined | BasePresets<Detail, Preset, PresetClass>

# savePreset(presetId)

src/abstract-presets.ts#L344

# presetId

string

savePreset(presetId)  =>

BasePresets<Detail, Preset, PresetClass>

# selectPreset(nextPresetId, byClick, newDetail, byGroup)

src/abstract-presets.ts#L302

# nextPresetId

string | false

# byClick

boolean

# newDetail

Detail

# byGroup

boolean

selectPreset(nextPresetId, byClick, newDetail, byGroup)  =>

BasePresets<Detail, Preset, PresetClass>

# setById(itemId, newItem)

# itemId

string

# newItem

U

setById<U extends  BasePreset<Detail, U>>(itemId, newItem)  =>

BasePresets<Detail, Preset, PresetClass>

# setDetailData(newDetailData, bySelect, byIntent, byGroup)

src/abstract-presets.ts#L215

# newDetailData

Detail ["data"]

# bySelect  =  false

boolean

# byIntent  =  false

boolean

# byGroup  =  false

boolean

setDetailData(newDetailData, bySelect, byIntent, byGroup)  =>

BasePresets<Detail, Preset, PresetClass>

# toJSON()

src/abstract-presets.ts#L101

toJSON()  =>

any

# updateById(itemId, updateData)

# itemId

string

# updateData

Partial<U>

updateById<U extends  BasePreset<Detail, U>>(itemId, updateData)  =>

BasePresets<Detail, Preset, PresetClass>

# PresetsGroupDetail

src/presets-group-detail.ts#L8

# constructor(data)

src/presets-group-detail.ts#L9

# new PresetsGroupDetail()

PresetsGroupDetail

# data

any

# data

src/abstract-presets.ts#L32

PresetsGroupData

# applyData(data)
src/presets-group-detail.ts#L34
# data

PresetsGroupData

applyData(data)  =>

undefined | Map<string, BasePresets<any, BasePreset<any>, Class<BasePreset<any>>>>

# collectData(sources)

src/presets-group-detail.ts#L19

# sources

Map<string, BasePresets<any, BasePreset<any>, Class<BasePreset<any>>>>

collectData(sources)  =>

any

# copy()

src/abstract-presets.ts#L50

copy()  =>

PresetsGroupData

# equals(other)

src/presets-group-detail.ts#L54

# other

PresetsGroupData | PresetsGroupDetail

equals(other)  =>

boolean

# merge(other)

src/presets-group-detail.ts#L115

# other

PresetsGroupData | PresetsGroupDetail

merge(other)  =>

PresetsGroupDetail

# satisfies(other)

src/presets-group-detail.ts#L90

# other

PresetsGroupData | PresetsGroupDetail

satisfies(other)  =>

boolean

# toJSON()

src/presets-group-detail.ts#L13

toJSON()  =>

any

# BasePresetsEvents

src/abstract-presets.ts#L56

# select

src/abstract-presets.ts#L57

# (next, prev, nextDetail, prevDetail, byClick, byGroup)
# next

null | Preset

# prev

null | Preset

# nextDetail

undefined | null | Detail

# prevDetail

null | Detail

# byClick

undefined | boolean

# byGroup

undefined | boolean

(next, prev, nextDetail, prevDetail, byClick, byGroup)  =>

void

# PresetsGroupData

src/presets-group-detail.ts#L4

# details

src/presets-group-detail.ts#L5

[ string, AbstractDetail<any> ] []

# sources

src/presets-group-detail.ts#L6

Map<string, BasePresets<any, BasePreset<any>, Class<BasePreset<any>>>>

Credits

• @stagas/immutable-list by stagas – Immutable list.
• 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