Class Document.BaseDocument

source · [−]

Expand description

This is an abstract class representing a document and provides methods for creating and manipulating documents.

@typeparam

T - The type of data stored in the document.

@typeparam

A - The type of action the document can take.

Constructors

source

constructor

source

new <T, A>(reducer: Reducer<T, BaseAction | A>, initialState?: Partial<Document<T, A>> & {
data: T;
}): BaseDocument<T, A>

Constructs a BaseDocument instance with an initial state.

Properties

source

state: Document<T, A>

Accessors

source

created

source

get (): string

Gets the timestamp of the date the document was created.

source

documentType

source

get (): string

Gets the type of document.

source

initialState

source

get (): Omit<Document<T, A>, "initialState">

Gets the initial state of the document.

source

lastModified

source

get (): string

Gets the timestamp of the date the document was last modified.

source

name

source

get (): string

Gets the name of the document.

source

operations

source

get (): Operation<BaseAction | A>[]

Gets the list of operations performed on the document.

source

revision

source

get (): number

Gets the revision number of the document.

Methods

source

dispatch

source

(action: BaseAction | A): BaseDocument<T, A>

Dispatches an action to update the state of the document.

@returns

The Document instance.

source

getAttachment

source

(attachment: string): DocumentFile

Gets the attachment associated with the given key.

source

loadFromFile

source

(path: string): Promise<void>

Loads the state of the document from a file.

source

loadState

source

(state: Pick<Document<T, A>, "name" | "data">, operations: number): void

Loads a document state and a set of operations.

source

prune

source

(start?: number, end?: number): void

Removes a range of operations from the document.

source

redo

source

(count: number): void

Reapplies a number of actions to the document.

source

saveToFile

source

(path: string, extension: string, name?: string): Promise<string>

Saves the state of the document to a file.

@returns

The file path where the state was saved.

source

setName

source

(name: string): void

Sets the name of the document.

source

undo

source

(count: number): void

Reverts a number of actions from the document.

source

stateFromFile

source

<T, A>(path: string, reducer: Reducer<T, BaseAction | A>): Promise<Document<T, BaseAction | A>>

Loads the state of the document from a file and returns it.

@returns

The state of the document.

Class Document.BaseDocument

Constructors

constructor

new <T, A>(reducer: Reducer<T, BaseAction | A>, initialState?: Partial<Document<T, A>> & { data: T; }): BaseDocument<T, A>

Properties

reducer

reducer: Reducer<T, BaseAction | A>

state

state: Document<T, A>

Accessors

created

get (): string

documentType

get (): string

initialState

get (): Omit<Document<T, A>, "initialState">

lastModified

get (): string

name

get (): string

operations

get (): Operation<BaseAction | A>[]

revision

get (): number

Methods

dispatch

(action: BaseAction | A): BaseDocument<T, A>

getAttachment

(attachment: string): DocumentFile

loadFromFile

(path: string): Promise<void>

loadState

(state: Pick<Document<T, A>, "name" | "data">, operations: number): void

prune

(start?: number, end?: number): void

redo

(count: number): void

saveToFile

(path: string, extension: string, name?: string): Promise<string>

setName

(name: string): void

undo

(count: number): void

stateFromFile

<T, A>(path: string, reducer: Reducer<T, BaseAction | A>): Promise<Document<T, BaseAction | A>>

new <T, A>(reducer: Reducer<T, BaseAction | A>, initialState?: Partial<Document<T, A>> & {
data: T;
}): BaseDocument<T, A>