Class Str

Hierarchy

Cell<V>
- Str (View Summary)

Index

Constructors

constructor

new Str(v?: string): Str
Parameters
- v: string = ""
Returns Str
Overrides Cell.constructor
- Defined in src/core/values/str.ts:63

Methods

derive

derive(this: Cell<string>, fn: (v: string) => string): this
Read-only same-type view: the RO dual of the endo .lens. For a cross-type view use the typed static Target.derive(src, fn).
Parameters
- this: Cell<string>
- fn: (v: string) => string
Returns this
Inherited from Cell.derive
- Defined in src/core/cell.ts:885

lens

lens(
 this: Cell<string>,
 fwd: (v: string) => string,
 bwd: (target: string, current: string) => string,
): this
Endomorphic lens. A 2-arg bwd(view, current) consults the current source; a 1-arg bwd(view) reconstructs it from the view alone.
Parameters
- this: Cell<string>
- fwd: (v: string) => string
- bwd: (target: string, current: string) => string
Returns this
Inherited from Cell.lens
- Defined in src/core/cell.ts:879

merge

merge(this: Cell<string>, fold?: MergeFold<string>): Cell<string>
Backward fan-in: forwards its parent's value unchanged; on write, folds N contributors into one value. fold defaults to last-writer-wins.
Parameters
- this: Cell<string>
- Optionalfold: MergeFold<string>
Returns Cell<string>
Inherited from Cell.merge
- Defined in src/core/cell.ts:914

peek

peek(): string
Returns string
Inherited from Cell.peek
- Defined in src/core/cell.ts:864

reverse

reverse(): this
Reverse.

Returns this
- Defined in src/core/values/str.ts:68

slice

slice(start: number, end?: number): Writable<Str>
Windowed view s.slice(start, end) (JS semantics). A write splices the text back into [start, end) of the live source, which grows or shrinks to fit; no stored complement.
Parameters
- start: number
- Optionalend: number
Returns Writable<Str>
- Defined in src/core/values/str.ts:99

split

split(sep: string | RegExp, joiner?: string): Arr<string>
Split into an editable Arr<string>. Each segment is a positional lens: reading index i re-splits the live source, writing it splices that piece back, so separators need no complement. Structural edits (insert/remove/ move) re-split and rebuild the source; added boundaries use joiner (defaults to sep, or " " for a pattern). Identity is by position.
Parameters
- sep: string | RegExp
- Optionaljoiner: string
Returns Arr<string>
- Defined in src/core/values/str.ts:118

through

through(this: Cell<string>, o: Optic<string, B>): Writable<Cell>
Apply optic value(s) as a writable lens: c.through(o) ≡ lens(c, o.get, o.put); multiple optics compose left-to-right (c.through(a, b) = a then b). Cross-type, unlike the endomorphic instance .lens.
Type Parameters
- B
Parameters
- this: Cell<string>
- o: Optic<string, B>
Returns Writable<Cell>
Inherited from Cell.through
- Defined in src/core/cell.ts:892
through<B, C>(
 this: Cell<string>,
 o1: Optic<string, B>,
 o2: Optic<B, C>,
): Writable<Cell<C>>
Apply optic value(s) as a writable lens: c.through(o) ≡ lens(c, o.get, o.put); multiple optics compose left-to-right (c.through(a, b) = a then b). Cross-type, unlike the endomorphic instance .lens.
Type Parameters
- B
- C
Parameters
- this: Cell<string>
- o1: Optic<string, B>
- o2: Optic<B, C>
Returns Writable<Cell<C>>
Inherited from Cell.through
- Defined in src/core/cell.ts:893
through<B, C, D>(
 this: Cell<string>,
 o1: Optic<string, B>,
 o2: Optic<B, C>,
 o3: Optic<C, D>,
): Writable<Cell<D>>
Apply optic value(s) as a writable lens: c.through(o) ≡ lens(c, o.get, o.put); multiple optics compose left-to-right (c.through(a, b) = a then b). Cross-type, unlike the endomorphic instance .lens.
Type Parameters
- B
- C
- D
Parameters
- this: Cell<string>
- o1: Optic<string, B>
- o2: Optic<B, C>
- o3: Optic<C, D>
Returns Writable<Cell<D>>
Inherited from Cell.through
- Defined in src/core/cell.ts:894

trim

trim(): Writable<Str>
Trim edge whitespace; the complement restores the original padding on write. A write's own edge whitespace is stripped first.

Returns Writable<Str>
- Defined in src/core/values/str.ts:74

`Static`coerce

coerce<C extends AnyCellCtor>(
this: C,
v: Val<Inner<InstanceType<C>>>,
): InstanceType<C>
Coerce Val<Inner<Cls>> → Cls: instance → identity, RO cell → tracked derive, literal → fresh seed.
Type Parameters
- C extends AnyCellCtor
Parameters
- this: C
- v: Val<Inner<InstanceType<C>>>
Returns InstanceType<C>
Inherited from Cell.coerce
- Defined in src/core/cell.ts:987

`Static`derive

derive<C extends AnyCellCtor, P>(
 this: C,
 parent: Read,
 fn: (v: P) => Inner<InstanceType<C>>,
): InstanceType<C>
Read-only typed view. Cls.derive(parent, fn) (1-input), Cls.derive(parents, fn) (N-input), or Cls.derive(fn) (closure). Polymorphic-this: Vec.derive(...) → Vec.
Type Parameters
- C extends AnyCellCtor
- P
Parameters
- this: C
- parent: Read
- fn: (v: P) => Inner<InstanceType<C>>
Returns InstanceType<C>
Inherited from Cell.derive
- Defined in src/core/cell.ts:932
derive<C extends AnyCellCtor, P extends readonly Read<unknown>[]>(
 this: C,
 parents: P,
 fn: (vals: ReadValues) => Inner<InstanceType<C>>,
): InstanceType<C>
Read-only typed view. Cls.derive(parent, fn) (1-input), Cls.derive(parents, fn) (N-input), or Cls.derive(fn) (closure). Polymorphic-this: Vec.derive(...) → Vec.
Type Parameters
- C extends AnyCellCtor
- P extends readonly Read<unknown>[]
Parameters
- this: C
- parents: P
- fn: (vals: ReadValues) => Inner<InstanceType<C>>
Returns InstanceType<C>
Inherited from Cell.derive
- Defined in src/core/cell.ts:937
derive<C extends AnyCellCtor>(
this: C,
fn: () => Inner<InstanceType<C>>,
): InstanceType<C>
Read-only typed view. Cls.derive(parent, fn) (1-input), Cls.derive(parents, fn) (N-input), or Cls.derive(fn) (closure). Polymorphic-this: Vec.derive(...) → Vec.
Type Parameters
- C extends AnyCellCtor
Parameters
- this: C
- fn: () => Inner<InstanceType<C>>
Returns InstanceType<C>
Inherited from Cell.derive
- Defined in src/core/cell.ts:942

`Static`is

is<C extends AnyCellCtor>(this: C, v: unknown): v is InstanceType<C>
Type predicate against this class: Vec.is(x) narrows x to Vec. Inherited static; works for any subclass via polymorphic this.
Type Parameters
- C extends AnyCellCtor
Parameters
- this: C
- v: unknown
Returns v is InstanceType<C>
Inherited from Cell.is
- Defined in src/core/cell.ts:981

`Static`lens

lens<C extends AnyCellCtor, P>(
 this: C,
 parent: Read,
 fwd: (v: P) => Inner<InstanceType<C>>,
 bwd: (target: Inner<InstanceType<C>>, v: P) => P,
): Writable<InstanceType<C>>
Writable lens. Cls.lens(parent, fwd, bwd) for one input, Cls.lens(parents, fwd, bwd) for N; a 2-arg bwd reads the source, a 1-arg bwd reconstructs it. Cls.lens(parent(s), spec) builds a complement-carrying lens from { init, step, fwd, bwd }.
Type Parameters
- C extends AnyCellCtor
- P
Parameters
- this: C
- parent: Read
- fwd: (v: P) => Inner<InstanceType<C>>
- bwd: (target: Inner<InstanceType<C>>, v: P) => P
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:952
lens<C extends AnyCellCtor, P extends readonly Read<unknown>[]>(
 this: C,
 parents: P,
 fwd: (vals: ReadValues) => Inner<InstanceType<C>>,
 bwd: (
 target: Inner<InstanceType<C>>,
 vals: ReadValues,
 ) => BackUpdates<ReadValuesOrSkip>,
): Writable<InstanceType<C>>
Writable lens. Cls.lens(parent, fwd, bwd) for one input, Cls.lens(parents, fwd, bwd) for N; a 2-arg bwd reads the source, a 1-arg bwd reconstructs it. Cls.lens(parent(s), spec) builds a complement-carrying lens from { init, step, fwd, bwd }.
Type Parameters
- C extends AnyCellCtor
- P extends readonly Read<unknown>[]
Parameters
- this: C
- parents: P
- fwd: (vals: ReadValues) => Inner<InstanceType<C>>
- bwd: (
 target: Inner<InstanceType<C>>,
 vals: ReadValues,
 ) => BackUpdates<ReadValuesOrSkip>
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:958
lens<C extends AnyCellCtor, P, Cm>(
 this: C,
 parent: Read,
 spec: StatefulLensSpec1<P, Inner<InstanceType<C>>, Cm>,
): Writable<InstanceType<C>>
Writable lens. Cls.lens(parent, fwd, bwd) for one input, Cls.lens(parents, fwd, bwd) for N; a 2-arg bwd reads the source, a 1-arg bwd reconstructs it. Cls.lens(parent(s), spec) builds a complement-carrying lens from { init, step, fwd, bwd }.
Type Parameters
- C extends AnyCellCtor
- P
- Cm
Parameters
- this: C
- parent: Read
- spec: StatefulLensSpec1<P, Inner<InstanceType<C>>, Cm>
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:964
lens<C extends AnyCellCtor, P extends readonly Read<unknown>[], Cm>(
 this: C,
 parents: P,
 spec: StatefulLensSpec<ReadValues, Inner<InstanceType<C>>, Cm>,
): Writable<InstanceType<C>>
Writable lens. Cls.lens(parent, fwd, bwd) for one input, Cls.lens(parents, fwd, bwd) for N; a 2-arg bwd reads the source, a 1-arg bwd reconstructs it. Cls.lens(parent(s), spec) builds a complement-carrying lens from { init, step, fwd, bwd }.
Type Parameters
- C extends AnyCellCtor
- P extends readonly Read<unknown>[]
- Cm
Parameters
- this: C
- parents: P
- spec: StatefulLensSpec<ReadValues, Inner<InstanceType<C>>, Cm>
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:969

`Static`pin

pin<C extends AnyCellCtor>(
this: C,
v: Inner<InstanceType<C>>,
): Writable<InstanceType<C>>
Writable-shaped constant: always reads v, absorbs writes (parentless sink lens), for APIs demanding bidirectionality.
Type Parameters
- C extends AnyCellCtor
Parameters
- this: C
- v: Inner<InstanceType<C>>
Returns Writable<InstanceType<C>>
Inherited from Cell.pin
- Defined in src/core/cell.ts:1000

Properties

`Readonly`_t

_t: { equals: (a: string, b: string) => boolean }

name

name: string | undefined

Optional debug label (cell(0, { name })); used by errors and graph dumps.

`Readonly`value

value: string

`Static`traits

traits: { equals: (a: string, b: string) => boolean } = ...

Class Str

Hierarchy

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Str

Methods

derive

Parameters

Returns this

lens

Parameters

Returns this

merge

Parameters

Returns Cell<string>

peek

Returns string

reverse

Returns this

slice

Parameters

Returns Writable<Str>

split

Parameters

Returns Arr<string>

through

Type Parameters

Parameters

Returns Writable<Cell<B>>

Type Parameters

Parameters

Returns Writable<Cell<C>>

Type Parameters

Parameters

Returns Writable<Cell<D>>

trim

Returns Writable<Str>

Staticcoerce

Type Parameters

Parameters

Returns InstanceType<C>

Staticderive

Type Parameters

Parameters

Returns InstanceType<C>

Type Parameters

Parameters

Returns InstanceType<C>

Type Parameters

Parameters

Returns InstanceType<C>

Staticis

Type Parameters

Parameters

Returns v is InstanceType<C>

Staticlens

Type Parameters

Parameters

Returns Writable<InstanceType<C>>

Type Parameters

Parameters

Returns Writable<InstanceType<C>>

Type Parameters

Parameters

Returns Writable<InstanceType<C>>

Type Parameters

Parameters

Returns Writable<InstanceType<C>>

Staticpin

Type Parameters

Parameters

Returns Writable<InstanceType<C>>

Properties

Readonly_t

name

`Static`coerce

`Static`derive

`Static`is

`Static`lens

`Static`pin

`Readonly`_t

`Readonly`value

`Static`traits