Class Text

Hierarchy

Text

Index

Constructors

constructor

new Text(text?: string | string[] | Value[]): Text
Parameters
- Optional text: string | string[] | Value[]
Returns Text
- Defined in src/text.ts:15

Properties

elems

elems: any[]

spans

spans: undefined | any[]

str

str: undefined | string

Accessors

length

get length(): number
Returns number
- Defined in src/text.ts:28

Methods

[iterator]

[iterator](): {
    next(): {
        done: boolean;
        value: any;
    } | {
        done: boolean;
        value?: undefined;
    };
}
Iterates over the text elements character by character, including any inline objects.

Returns {
    next(): {
        done: boolean;
        value: any;
    } | {
        done: boolean;
        value?: undefined;
    };
}
- next:function
  - next(): {
        done: boolean;
        value: any;
    } | {
        done: boolean;
        value?: undefined;
    }
  - Returns {
        done: boolean;
        value: any;
    } | {
        done: boolean;
        value?: undefined;
    }
    - Defined in src/text.ts:45
- Defined in src/text.ts:41

concat

concat(other: Text): Text
Parameters
- other: Text
Returns Text
- Defined in src/text.ts:160

deleteAt

deleteAt(index: number, numDelete?: number): void
Deletes numDelete list items starting at position index. if numDelete is not given, one item is deleted.
Parameters
- index: number
- numDelete: number = 1
Returns void
- Defined in src/text.ts:143

every

every(test: ((v: Value) => boolean)): boolean
Parameters
- test: ((v: Value) => boolean)
  - - (v: Value): boolean
    - Parameters
      
      v: Value
      
      Returns boolean
Returns boolean
- Defined in src/text.ts:164

filter

filter(test: ((v: Value) => boolean)): Text
Parameters
- test: ((v: Value) => boolean)
  - - (v: Value): boolean
    - Parameters
      
      v: Value
      
      Returns boolean
Returns Text
- Defined in src/text.ts:168

find

find(test: ((v: Value) => boolean)): undefined | Value
Parameters
- test: ((v: Value) => boolean)
  - - (v: Value): boolean
    - Parameters
      
      v: Value
      
      Returns boolean
Returns undefined | Value
- Defined in src/text.ts:172

findIndex

findIndex(test: ((v: Value) => boolean)): undefined | number
Parameters
- test: ((v: Value) => boolean)
  - - (v: Value): boolean
    - Parameters
      
      v: Value
      
      Returns boolean
Returns undefined | number
- Defined in src/text.ts:176

forEach

forEach(f: ((v: Value) => undefined)): void
Parameters
- f: ((v: Value) => undefined)
  - - (v: Value): undefined
    - Parameters
      
      v: Value
      
      Returns undefined
Returns void
- Defined in src/text.ts:180

get

get(index: number): any
Parameters
- index: number
Returns any
- Defined in src/text.ts:33

includes

includes(elem: Value): boolean
Parameters
- elem: Value
Returns boolean
- Defined in src/text.ts:184

indexOf

indexOf(elem: Value): number
Parameters
- elem: Value
Returns number
- Defined in src/text.ts:188

insertAt

insertAt(index: number, ...values: Value[]): void
Inserts new list items values starting at position index.
Parameters
- index: number
- Rest ...values: Value[]
Returns void
- Defined in src/text.ts:126

join

join(sep?: string): string
Parameters
- Optional sep: string
Returns string
- Defined in src/text.ts:192

lastIndexOf

lastIndexOf(searchElement: Value, fromIndex?: number): void
Parameters
- searchElement: Value
- Optional fromIndex: number
Returns void
- Defined in src/text.ts:156

map

map<T>(callback: ((e: Value) => T)): void
Type Parameters
- T
Parameters
- callback: ((e: Value) => T)
  - - (e: Value): T
    - Parameters
      
      e: Value
      
      Returns T
Returns void
- Defined in src/text.ts:152

reduce

reduce(f: ((previousValue: Value, currentValue: Value, currentIndex: number, array: Value[]) => Value)): void
Parameters
- f: ((previousValue: Value, currentValue: Value, currentIndex: number, array: Value[]) => Value)
  - - (previousValue: Value, currentValue: Value, currentIndex: number, array: Value[]): Value
    - Parameters
      
      previousValue: Value
      
      currentValue: Value
      
      currentIndex: number
      
      array: Value[]
      
      Returns Value
Returns void
- Defined in src/text.ts:196

reduceRight

reduceRight(f: ((previousValue: Value, currentValue: Value, currentIndex: number, array: Value[]) => Value)): void
Parameters
- f: ((previousValue: Value, currentValue: Value, currentIndex: number, array: Value[]) => Value)
  - - (previousValue: Value, currentValue: Value, currentIndex: number, array: Value[]): Value
    - Parameters
      
      previousValue: Value
      
      currentValue: Value
      
      currentIndex: number
      
      array: Value[]
      
      Returns Value
Returns void
- Defined in src/text.ts:207

set

set(index: number, value: Value): void
Updates the list item at position index to a new value value.
Parameters
- index: number
- value: Value
Returns void
- Defined in src/text.ts:114

slice

slice(start?: number, end?: number): Text
Parameters
- Optional start: number
- Optional end: number
Returns Text
- Defined in src/text.ts:218

some

some(test: ((arg: Value) => boolean)): boolean
Parameters
- test: ((arg: Value) => boolean)
  - - (arg: Value): boolean
    - Parameters
      
      arg: Value
      
      Returns boolean
Returns boolean
- Defined in src/text.ts:222

toJSON

toJSON(): string
Returns the content of the Text object as a simple string, so that the JSON serialization of an Automerge document represents text nicely.

Returns string
- Defined in src/text.ts:107

toLocaleString

toLocaleString(): void
Returns void
- Defined in src/text.ts:226

toSpans

toSpans(): Value[]
Returns the content of the Text object as a sequence of strings, interleaved with non-character elements.

For example, the value ['a', 'b', {x: 3}, 'c', 'd'] has spans: => ['ab', {x: 3}, 'cd']

Returns Value[]
- Defined in src/text.ts:81

toString

toString(): string
Returns the content of the Text object as a simple string, ignoring any non-character elements.

Returns string
- Defined in src/text.ts:60

Class Text

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional text: string | string[] | Value[]

Returns Text

Properties

elems

spans

str

Accessors

length

Returns number

Methods

[iterator]

Returns { next(): { done: boolean; value: any; } | { done: boolean; value?: undefined; }; }

next:function

Returns { done: boolean; value: any; } | { done: boolean; value?: undefined; }

concat

Parameters

other: Text

Returns Text

deleteAt

Parameters

index: number

numDelete: number = 1

Returns void

every

Parameters

test: ((v: Value) => boolean)

Parameters

v: Value

Returns boolean

Returns boolean

filter

Parameters

test: ((v: Value) => boolean)

Parameters

v: Value

Returns boolean

Returns Text

find

Parameters

test: ((v: Value) => boolean)

Parameters

v: Value

Returns boolean

Returns undefined | Value

findIndex

Parameters

test: ((v: Value) => boolean)

Parameters

v: Value

Returns boolean

Returns undefined | number

forEach

Parameters

f: ((v: Value) => undefined)

Parameters

v: Value

Returns undefined

Returns void

get

Parameters

index: number

Returns any

includes

Parameters

elem: Value

Returns boolean

indexOf

Parameters

elem: Value

Returns number

`Optional` text: string | string[] | Value[]

Returns {
next(): {
done: boolean;
value: any;
} | {
done: boolean;
value?: undefined;
};
}

Returns {
done: boolean;
value: any;
} | {
done: boolean;
value?: undefined;
}

`Rest` ...values: Value[]

`Optional` sep: string

`Optional` fromIndex: number

`Optional` start: number

`Optional` end: number