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:854

lens

lens(
 this: Cell<string>,
 fwd: (v: string) => string,
 bwd: (target: string, current: string) => string,
): this
Endomorphic lens from a fwd/bwd pair (2-arg bwd reads the source, 1-arg reconstructs it), or apply optic value(s), chaining left-to-right. A chain whose every hop is T → T stays same-type (returns this); a chain that changes the value type yields a plain Cell of the final view.
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:839
lens(
this: Cell<string>,
...optics: readonly AppliedOptic<string, string>[],
): this
Endomorphic lens from a fwd/bwd pair (2-arg bwd reads the source, 1-arg reconstructs it), or apply optic value(s), chaining left-to-right. A chain whose every hop is T → T stays same-type (returns this); a chain that changes the value type yields a plain Cell of the final view.
Parameters
- this: Cell<string>
- ...optics: readonly AppliedOptic<string, string>[]
Returns this
Inherited from Cell.lens
- Defined in src/core/cell.ts:840
lens<V1>(
this: Cell<string>,
optic: AppliedOptic<string, V1>,
): Writable<Cell<V1>>
Endomorphic lens from a fwd/bwd pair (2-arg bwd reads the source, 1-arg reconstructs it), or apply optic value(s), chaining left-to-right. A chain whose every hop is T → T stays same-type (returns this); a chain that changes the value type yields a plain Cell of the final view.
Type Parameters
- V1
Parameters
- this: Cell<string>
- optic: AppliedOptic<string, V1>
Returns Writable<Cell<V1>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:841
lens<Os extends AnyOptics>(
this: Cell<string>,
...optics: Os,
): Writable<Cell<ChainResult<string, Os>>>
Endomorphic lens from a fwd/bwd pair (2-arg bwd reads the source, 1-arg reconstructs it), or apply optic value(s), chaining left-to-right. A chain whose every hop is T → T stays same-type (returns this); a chain that changes the value type yields a plain Cell of the final view.
Type Parameters
- Os extends AnyOptics
Parameters
- this: Cell<string>
- ...optics: Os
Returns Writable<Cell<ChainResult<string, Os>>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:842

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:860

peek

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

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:100

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:119

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:945

`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:878
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:883
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:888

`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:939

`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, typed to this class. 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), optic, …) applies an optic value (pure or complement-carrying), chaining left-to-right onto this class.
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:898
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, typed to this class. 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), optic, …) applies an optic value (pure or complement-carrying), chaining left-to-right onto this class.
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:904
lens<C extends AnyCellCtor, P>(
 this: C,
 parent: Read,
 optic: AppliedOptic<P, Inner<InstanceType<C>>>,
): Writable<InstanceType<C>>
Writable lens, typed to this class. 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), optic, …) applies an optic value (pure or complement-carrying), chaining left-to-right onto this class.
Type Parameters
- C extends AnyCellCtor
- P
Parameters
- this: C
- parent: Read
- optic: AppliedOptic<P, Inner<InstanceType<C>>>
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:910
lens<C extends AnyCellCtor, P extends readonly Read<unknown>[]>(
 this: C,
 parents: P,
 optic: AppliedOptic<ReadValues, Inner<InstanceType<C>>>,
): Writable<InstanceType<C>>
Writable lens, typed to this class. 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), optic, …) applies an optic value (pure or complement-carrying), chaining left-to-right onto this class.
Type Parameters
- C extends AnyCellCtor
- P extends readonly Read<unknown>[]
Parameters
- this: C
- parents: P
- optic: AppliedOptic<ReadValues, Inner<InstanceType<C>>>
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:915
lens<C extends AnyCellCtor, P, Os extends AnyOptics>(
 this: C,
 parent: Read,
 ...optics: Os,
): ChainResult<P, Os> extends Inner<InstanceType<C>>
 ? Writable<InstanceType<C>>
 : never
Writable lens, typed to this class. 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), optic, …) applies an optic value (pure or complement-carrying), chaining left-to-right onto this class.
Type Parameters
- C extends AnyCellCtor
- P
- Os extends AnyOptics
Parameters
- this: C
- parent: Read
- ...optics: Os
Returns ChainResult<P, Os> extends Inner<InstanceType<C>>
? Writable<InstanceType<C>>
: never
Inherited from Cell.lens
- Defined in src/core/cell.ts:920
lens<
 C extends AnyCellCtor,
 P extends readonly Read<unknown>[],
 Os extends AnyOptics,
>(
 this: C,
 parents: P,
 ...optics: Os,
): ChainResult<ReadValues, Os> extends Inner<InstanceType<C>>
 ? Writable<InstanceType<C>>
 : never
Writable lens, typed to this class. 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), optic, …) applies an optic value (pure or complement-carrying), chaining left-to-right onto this class.
Type Parameters
- C extends AnyCellCtor
- P extends readonly Read<unknown>[]
- Os extends AnyOptics
Parameters
- this: C
- parents: P
- ...optics: Os
Returns ChainResult<ReadValues, Os> extends Inner<InstanceType<C>>
? Writable<InstanceType<C>>
: never
Inherited from Cell.lens
- Defined in src/core/cell.ts:925

`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:958

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

Parameters

Returns this

Type Parameters

Parameters

Returns Writable<Cell<V1>>

Type Parameters

Parameters

Returns Writable<Cell<ChainResult<string, Os>>>

merge

Parameters

Returns Cell<string>

peek

Returns string

reverse

Returns this

slice

Parameters

Returns Writable<Str>

split

Parameters

Returns Arr<string>

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>>

Type Parameters

Parameters

Returns ChainResult<P, Os> extends Inner<InstanceType<C>> ? Writable<InstanceType<C>> : never

Type Parameters

Parameters

Returns ChainResult<ReadValues<P>, Os> extends Inner<InstanceType<C>> ? Writable<InstanceType<C>> : never

Staticpin

Type Parameters

Parameters

`Static`coerce

`Static`derive

`Static`is

`Static`lens

Returns ChainResult<P, Os> extends Inner<InstanceType<C>>
? Writable<InstanceType<C>>
: never

Returns ChainResult<ReadValues<P>, Os> extends Inner<InstanceType<C>>
? Writable<InstanceType<C>>
: never

`Static`pin

`Readonly`_t

`Readonly`value

`Static`traits