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

# add(object, fromRemote)

# object

# fromRemote = false

boolean

add(object, fromRemote) =>

SyncedSet

# clear()

clear() =>

void

# delete(object)

# object

delete(object) =>

boolean

# deleteById(id)

# id

T [keyof T]

deleteById(id) =>

void

# emit(eventName, args)

# eventName

# args

Parameters<SyncedSetEvents<T> [K]>

emit<K>(eventName, args) =>

SyncedSet

# forEach(callback, thisArg)

# callback(value, value2, set)

# value

# value2

# set

Set<T>

callback(value, value2, set) =>

void

# thisArg

any

forEach(callback, thisArg) =>

void

# has(object)

# object

has(object) =>

boolean

# off(eventName, callback)

# eventName

# callback

SyncedSetEvents<T> [K]

off<K>(eventName, callback) =>

SyncedSet

# on(eventName, callback, options)

# eventName

# callback

SyncedSetEvents<T> [K]

# options

EventEmitterOptions

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

Off

# once(eventName, callback)

# eventName

# callback

SyncedSetEvents<T> [K]

once<K>(eventName, callback) =>

Off

# receive(payload)

# payload

SyncedSetPayload<T>

receive(payload) =>

void

# send()

send() =>

void

# update(object)

# object

update(object) =>

void

# SyncedSetEvents

# add

# (item)

# item

(item) =>

void

# delete

# (item)

# item

(item) =>

void

# update

# (item, key)

# item

# key

keyof T

(item, key) =>

void

# SyncedSetOptions

# id

keyof T

# pick

keyof T []

# equal(prev, next)

# prev

# next

equal(prev, next) =>

boolean

# reducer(object)

# object

reducer(object) =>

# send(payload, cb)

# payload

SyncedSetPayload<T>

# cb()

cb() =>

void

send(payload, cb) =>

void

# SyncedSetOptionsOptionalId

# id

keyof T

# pick

keyof T []

# equal(prev, next)

# prev

# next

equal(prev, next) =>

boolean

# reducer(object)

# object

reducer(object) =>

# 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](https://npmjs.org/package/event-toolkit) by [stagas](https://github.com/stagas) – Toolkit for DOM events. - [everyday-utils](https://npmjs.org/package/everyday-utils) by [stagas](https://github.com/stagas) – Everyday utilities - [pick-omit](https://npmjs.org/package/pick-omit) by [stagas](https://github.com/stagas) – The two missing object methods we always need. ## Contributing [Fork](https://github.com/stagas/synced-set/fork) or [edit](https://github.dev/stagas/synced-set) and submit a PR. All contributions are welcome! ## License MIT © 2023 [stagas](https://github.com/stagas)

synced-set

npm i synced-set pnpm add synced-set yarn add synced-set

`npm i synced-set` `pnpm add synced-set` `yarn add synced-set`