Class BudgetStatement.BudgetStatement

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 (initialState?: Partial<Omit<BudgetStatementDocument, "data"> & {
data: Partial<BudgetStatementData>;
}>): BudgetStatement

Creates a new BudgetStatement instance.

Properties

source

fileExtension: string = 'phbs'

The file extension used to save budget statements.

Account

source

accounts

source

get (): Account[]

Returns an array of all accounts in the budget statement.

source

addAccount

source

(accounts: AccountInput[]): BudgetStatement

Adds one or more accounts to the budget statement.

source

deleteAccount

source

(accounts: string[]): BudgetStatement

Deletes one or more accounts from the budget statement.

source

getAccount

source

(address: string): undefined | Account

Returns the Account object with the specified address.

source

sortAccounts

source

(accounts: string[]): BudgetStatement

Sorts the accounts inthe budget statement.

source

updateAccount

source

(accounts: AccountUpdateInput[]): BudgetStatement

Updates one or more existing accounts in the budget statement.

Budget Statement

source

month

source

get (): Maybe<string>

Gets the month of the budget statement.

source

owner

source

get (): Maybe<Owner>

Gets the owner of the budget statement.

source

quoteCurrency

source

get (): Maybe<string>

Gets the quote currency of the budget statement.

Other

source

comments

source

get (): Comment[]

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

ftes

source

get (): Maybe<Ftes>

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.

source

vesting

source

get (): Vesting[]

Audit

source

addAuditReport

source

(reports: {
    report: DocumentFile;
    status: AuditReportStatus;
    timestamp?: string;
}[]): BudgetStatement

Adds audit reports to the budget statement.

source

deleteAuditReport

source

(reports: string[]): BudgetStatement

Deletes audit reports from the budget statement.

source

getAuditReport

source

(report: string): undefined | AuditReport

Retrieves a specific audit report from the budget statement.

@returns

The audit report object if it exists, or undefined if not.

source

getAuditReports

source

(): AuditReport[]

Retrieves all audit reports from the budget statement.

@returns

An array of audit report objects.

Methods

source

addComment

source

(comments: CommentInput[]): BudgetStatement

source

addVesting

source

(vesting: VestingInput[]): BudgetStatement

source

deleteComment

source

(comments: string[]): BudgetStatement

source

deleteVesting

source

(vesting: string[]): BudgetStatement

source

dispatch

source

(action: BaseAction | BudgetStatementAction): BudgetStatement

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

getComment

source

(key: string): undefined | Comment

source

getVesting

source

(key: string): undefined | Vesting

source

loadFromFile

source

(path: string): Promise<void>

Loads the budget statement from a file.

@returns

A promise that resolves with the loaded BudgetStatement instance.

source

loadState

source

(state: Pick<Document<BudgetStatementData, BudgetStatementAction>, "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, name?: string): Promise<string>

Saves the budget statement to a file.

@returns

A promise that resolves when the save operation completes.

source

setFtes

source

(ftes: FtesInput): BudgetStatement

source

setMonth

source

(month: string): BudgetStatement

source

setName

source

(name: string): void

Sets the name of the document.

source

setOwner

source

(owner: OwnerInput): BudgetStatement

source

setQuoteCurrency

source

(currency: string): BudgetStatement

source

undo

source

(count: number): void

Reverts a number of actions from the document.

source

updateComment

source

(comments: CommentUpdateInput[]): BudgetStatement

source

updateVesting

source

(vesting: VestingUpdateInput[]): BudgetStatement

source

fromFile

source

(path: string): Promise<BudgetStatement>

Creates a new BudgetStatement instance from a file.

@returns

A promise that resolves with the loaded BudgetStatement instance.

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.

Line Item

source

addLineItem

source

(account: string, lineItems: (Partial<LineItem> & Pick<LineItem, "category" | "group">)[]): BudgetStatement

Adds a line item to the specified account.

source

deleteLineItem

source

(account: string, lineItems: LineItemDeleteInput[]): BudgetStatement

Deletes line items for the specified account.

source

getLineItem

source

(account: string, lineItem: LineItemDeleteInput): undefined | LineItem

Retrieves a specific line item for the specified account.

@returns

The line item object that matches the specified category and group, or undefined if it does not exist.

source

getLineItems

source

(account: string): undefined | LineItem[]

Retrieves line items for the specified account.

@returns

An array of line item objects for the specified account, or undefined if the account does not exist.

source

sortLineItems

source

(account: string, lineItems: LineItemsSortInput[]): BudgetStatement

Sorts the line items of an account.

source

updateLineItem

source

(account: string, lineItems: LineItemUpdateInput[]): BudgetStatement

Updates line items for the specified account.

Class BudgetStatement.BudgetStatement

Constructors

constructor

new (initialState?: Partial<Omit<BudgetStatementDocument, "data"> & { data: Partial<BudgetStatementData>; }>): BudgetStatement

Properties

state

state: Document<BudgetStatementData, BudgetStatementAction>

fileExtension

fileExtension: string = 'phbs'

Account

accounts

get (): Account[]

addAccount

(accounts: AccountInput[]): BudgetStatement

deleteAccount

(accounts: string[]): BudgetStatement

getAccount

(address: string): undefined | Account

sortAccounts

(accounts: string[]): BudgetStatement

updateAccount

(accounts: AccountUpdateInput[]): BudgetStatement

Budget Statement

month

get (): Maybe<string>

owner

get (): Maybe<Owner>

quoteCurrency

get (): Maybe<string>

Other

comments

get (): Comment[]

created

get (): string

documentType

get (): string

ftes

get (): Maybe<Ftes>

initialState

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

lastModified

get (): string

name

get (): string

operations

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

revision

get (): number

vesting

get (): Vesting[]

Audit

addAuditReport

(reports: { report: DocumentFile; status: AuditReportStatus; timestamp?: string; }[]): BudgetStatement

deleteAuditReport

(reports: string[]): BudgetStatement

getAuditReport

(report: string): undefined | AuditReport

getAuditReports

(): AuditReport[]

Methods

addComment

(comments: CommentInput[]): BudgetStatement

addVesting

(vesting: VestingInput[]): BudgetStatement

deleteComment

(comments: string[]): BudgetStatement

deleteVesting

(vesting: string[]): BudgetStatement

dispatch

(action: BaseAction | BudgetStatementAction): BudgetStatement

getAttachment

(attachment: string): DocumentFile

getComment

(key: string): undefined | Comment

getVesting

(key: string): undefined | Vesting

loadFromFile

(path: string): Promise<void>

loadState

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

new (initialState?: Partial<Omit<BudgetStatementDocument, "data"> & {
data: Partial<BudgetStatementData>;
}>): BudgetStatement

(reports: {
report: DocumentFile;
status: AuditReportStatus;
timestamp?: string;
}[]): BudgetStatement