Skip to content

OUTDATED.md

Latest commit

 

History

History
executable file
·
105 lines (71 loc) · 2.91 KB

OUTDATED.md

File metadata and controls

executable file
·
105 lines (71 loc) · 2.91 KB

OUTDATED DOCUMENTATION

⚠️ This file contains outdated API documentation. The current API has changed significantly. Please refer to the main README.md for the latest documentation.

The information below represents the old API from earlier versions of Object.ts and is kept for historical reference only.

Installation

npm install object.ts

or

yarn add object.ts

Usage

import { makeReactive, ref, subscribe } from 'object.ts';

const state = makeReactive({ count: 0 });

const unsubscribe = subscribe(state, () => {
  console.log('State changed:', state.count);
});

state.count = 1; // Triggers subscriber
unsubscribe();   // Unsubscribe when needed

API Reference

Reactivity

  • makeReactive(initial) Creates a reactive primitive from an existing object.

  • subscribe(obj, [key], callback) Subscribes to changes in an observable object, Set, or Map.

    • Supports [obj, key] to subscribe to a specific property.
    • Returns an unsubscribe function.

  • deref(obj) Dereferences a WeakRef or .value-based object.

  • promised(obj) Wraps an awaitable promise as a reactive value.

    • Reacts only to Promise.resolve.

  • ref(initial) Creates an observable reference with a value property.

  • computed(sub) Similar to ref, but computes its value from a reactive source.

    • Setting the value has no effect on the source.

  • unified(...objs) Combines multiple observable objects into one (read-only).

  • remap(obj, cb) Creates a remapped reactive object with a different keyset (read-only).

  • weak(initial) Like ref, but the value is always a WeakRef and may disappear without notification.

  • conditional(cond, ifTrue, ifFalse) Reactive value that switches between ifTrue and ifFalse based on cond.value.

  • safe(target) Prepares an object for serialization to JSON or JSOX.

DOM Utilities

  • matchMediaRef(mediaValue) Creates a reactive ref based on a matchMedia query.

  • localStorageRef(name, initial) Creates a persistent reactive ref synchronized with localStorage.

    • Note: Does not currently react to changes from other tabs or windows with the same key.

Breaking Changes

Function Name Changes

Old API New API
makeReactive(obj) observe(obj)
subscribe(obj, cb) affected(obj, cb)
observe(obj, cb) iterated(obj, cb)

Removed Functions

  • deref() - Replaced with utility functions
  • weak() - No longer available
  • unified() - Replaced with bindBy and derivate
  • matchMediaRef() - Moved to separate library
  • localStorageRef() - Moved to separate library

Related Projects

  • BLU.E (2025) — Built on top of Object.ts.
  • Uniform.TS — The major sibling project.