synced-set

Synchronize a Set collection of objects across a wire.

npm i synced-set

pnpm add synced-set

yarn add synced-set

API

# SyncedSet

# constructor(options)

# new SyncedSet()

SyncedSet<T, R>

# options

SyncedSetOptionsOptionalId<T, R>

# added  =  ...

Set<T>

# deleted  =  ...

Set<T [keyof T]>

# map  =  ...

Map<T [keyof T], T>

# options

SyncedSetOptions<T, R>

# updated  =  ...

Set<T>

# listeners
# size
# [iterator]()
[iterator]()  =>

IterableIterator<T>

# add(object, fromRemote)

# object

T

# fromRemote  =  false

boolean

add(object, fromRemote)  =>

SyncedSet<T, R>

# clear()

clear()  =>

void

# delete(object)

# object

T

delete(object)  =>

boolean

# deleteById(id)

# id

T [keyof T]

deleteById(id)  =>

void

# emit(eventName, args)

# eventName

K

# args

Parameters<SyncedSetEvents<T> [K]>

emit<K>(eventName, args)  =>

SyncedSet<T, R>

# forEach(callback, thisArg)

# callback(value, value2, set)
# value

T

# value2

T

# set

Set<T>

callback(value, value2, set)  =>

void

# thisArg

any

forEach(callback, thisArg)  =>

void

# has(object)

# object

T

has(object)  =>

boolean

# off(eventName, callback)

# eventName

K

# callback

SyncedSetEvents<T> [K]

off<K>(eventName, callback)  =>

undefined | SyncedSet<T, R>

# on(eventName, callback, options)

# eventName

K

# callback

SyncedSetEvents<T> [K]

# options

EventEmitterOptions

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

Off

# once(eventName, callback)

# eventName

K

# callback

SyncedSetEvents<T> [K]

once<K>(eventName, callback)  =>

Off

# receive(payload)

# payload

SyncedSetPayload<T>

receive(payload)  =>

void

# send()

send()  =>

void

# update(object)

# object

T

update(object)  =>

void

# SyncedSetEvents

# add

# (item)
# item

T

(item)  =>

void

# delete

# (item)
# item

T

(item)  =>

void

# update

# (item, key)
# item

T

# key

keyof T

(item, key)  =>

void

# SyncedSetOptions

# id

keyof T

# pick

keyof T []

# equal(prev, next)
# prev

R

# next

R

equal(prev, next)  =>

boolean

# reducer(object)

# object

T

reducer(object)  =>

R

# send(payload, cb)

# payload

SyncedSetPayload<T>

# cb()
cb()  =>

void

send(payload, cb)  =>

void

# SyncedSetOptionsOptionalId

# id

keyof T

# pick

keyof T []

# equal(prev, next)
# prev

R

# next

R

equal(prev, next)  =>

boolean

# reducer(object)

# object

T

reducer(object)  =>

R

# send(payload, cb)

# payload

SyncedSetPayload<T>

# cb()
cb()  =>

void

send(payload, cb)  =>

void

# SyncedSetPayload

# added

Set<T>

# deleted

Set<T [keyof T]>

# updated

Set<T>

# Id

keyof T

Credits

• event-toolkit by stagas – Toolkit for DOM events.
• everyday-utils by stagas – Everyday utilities
• pick-omit by stagas – The two missing object methods we always need.

Contributing

Fork or edit and submit a PR.

All contributions are welcome!

License

MIT © 2023 stagas