Collections

Classes

Classes

ApprovalOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: ApprovalFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<ApprovalModel>

Parameters:

ParameterTypeRequiredDescription
filtersApprovalFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<ApprovalModel> -

findOne

findOne(approvalId: string): Promise<ApprovalModel | null>

Parameters:

ParameterTypeRequiredDescription
approvalIdstringYes

Returns:

Promise<ApprovalModel \| null> -

count

count(filters: ApprovalFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersApprovalFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<ApprovalModel, CreateApprovalInput>

Returns:

MutationOperator<ApprovalModel, CreateApprovalInput> -

updateMutation

updateMutation(): MutationOperator<ApprovalModel, UpdateApprovalInput>

Returns:

MutationOperator<ApprovalModel, UpdateApprovalInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

AttributeOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: AttributeFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<AttributeModel>

Parameters:

ParameterTypeRequiredDescription
filtersAttributeFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<AttributeModel> -

findOne

findOne(attributeId: string): Promise<AttributeModel | null>

Parameters:

ParameterTypeRequiredDescription
attributeIdstringYes

Returns:

Promise<AttributeModel \| null> -

count

count(filters: AttributeFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersAttributeFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<AttributeModel, CreateAttributeInput>

Returns:

MutationOperator<AttributeModel, CreateAttributeInput> -

updateMutation

updateMutation(): MutationOperator<AttributeModel, UpdateAttributeInput>

Returns:

MutationOperator<AttributeModel, UpdateAttributeInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

BusinessPlanOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: BusinessPlanFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<BusinessPlanModel>

Parameters:

ParameterTypeRequiredDescription
filtersBusinessPlanFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<BusinessPlanModel> -

findOne

findOne(planId: string): Promise<BusinessPlanModel | null>

Parameters:

ParameterTypeRequiredDescription
planIdstringYes

Returns:

Promise<BusinessPlanModel \| null> -

count

count(filters: BusinessPlanFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersBusinessPlanFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<BusinessPlanModel, CreateBusinessPlanInput>

Returns:

MutationOperator<BusinessPlanModel, CreateBusinessPlanInput> -

updateMutation

updateMutation(): MutationOperator<BusinessPlanModel, UpdateBusinessPlanInput>

Returns:

MutationOperator<BusinessPlanModel, UpdateBusinessPlanInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

ClientOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: ClientFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<ClientModel>

Parameters:

ParameterTypeRequiredDescription
filtersClientFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<ClientModel> -

findOne

findOne(clientId: string): Promise<ClientModel | null>

Parameters:

ParameterTypeRequiredDescription
clientIdstringYes

Returns:

Promise<ClientModel \| null> -

count

count(filters: ClientFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersClientFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<ClientModel, CreateClientInput>

Returns:

MutationOperator<ClientModel, CreateClientInput> -

updateMutation

updateMutation(): MutationOperator<ClientModel, UpdateClientInput>

Returns:

MutationOperator<ClientModel, UpdateClientInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

CodebaseOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: CodebaseFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<CodebaseModel>

Parameters:

ParameterTypeRequiredDescription
filtersCodebaseFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<CodebaseModel> -

findOne

findOne(codebaseId: string): Promise<CodebaseModel | null>

Parameters:

ParameterTypeRequiredDescription
codebaseIdstringYes

Returns:

Promise<CodebaseModel \| null> -

count

count(filters: CodebaseFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersCodebaseFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<CodebaseModel, CreateCodebaseInput>

Returns:

MutationOperator<CodebaseModel, CreateCodebaseInput> -

updateMutation

updateMutation(): MutationOperator<CodebaseModel, UpdateCodebaseInput>

Returns:

MutationOperator<CodebaseModel, UpdateCodebaseInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

CompetitorOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: CompetitorFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<CompetitorModel>

Parameters:

ParameterTypeRequiredDescription
filtersCompetitorFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<CompetitorModel> -

findOne

findOne(competitorId: string): Promise<CompetitorModel | null>

Parameters:

ParameterTypeRequiredDescription
competitorIdstringYes

Returns:

Promise<CompetitorModel \| null> -

createMutation

createMutation(): MutationOperator<CompetitorModel, CreateCompetitorInput>

Returns:

MutationOperator<CompetitorModel, CreateCompetitorInput> -

updateMutation

updateMutation(): MutationOperator<CompetitorModel, UpdateCompetitorInput>

Returns:

MutationOperator<CompetitorModel, UpdateCompetitorInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

ContactOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: ContactFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<ContactModel>

Parameters:

ParameterTypeRequiredDescription
filtersContactFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<ContactModel> -

findOne

findOne(contactId: string): Promise<ContactModel | null>

Parameters:

ParameterTypeRequiredDescription
contactIdstringYes

Returns:

Promise<ContactModel \| null> -

count

count(filters: ContactFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersContactFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<ContactModel, CreateContactInput>

Returns:

MutationOperator<ContactModel, CreateContactInput> -

updateMutation

updateMutation(): MutationOperator<ContactModel, UpdateContactInput>

Returns:

MutationOperator<ContactModel, UpdateContactInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

ConversationOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: ConversationFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<ConversationModel>

Parameters:

ParameterTypeRequiredDescription
filtersConversationFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<ConversationModel> -

findOne

findOne(conversationId: string): Promise<ConversationModel | null>

Parameters:

ParameterTypeRequiredDescription
conversationIdstringYes

Returns:

Promise<ConversationModel \| null> -

count

count(filters: ConversationFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersConversationFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<ConversationModel, CreateConversationInput>

Returns:

MutationOperator<ConversationModel, CreateConversationInput> -

updateMutation

updateMutation(): MutationOperator<ConversationModel, UpdateConversationInput>

Returns:

MutationOperator<ConversationModel, UpdateConversationInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

DiscussionOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: DiscussionFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<DiscussionModel>

Parameters:

ParameterTypeRequiredDescription
filtersDiscussionFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<DiscussionModel> -

findOne

findOne(discussionId: string): Promise<DiscussionModel | null>

Parameters:

ParameterTypeRequiredDescription
discussionIdstringYes

Returns:

Promise<DiscussionModel \| null> -

count

count(filters: DiscussionFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersDiscussionFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<DiscussionModel, CreateDiscussionInput>

Returns:

MutationOperator<DiscussionModel, CreateDiscussionInput> -

updateMutation

updateMutation(): MutationOperator<DiscussionModel, UpdateDiscussionInput>

Returns:

MutationOperator<DiscussionModel, UpdateDiscussionInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

DocumentOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: DocumentFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<DocumentModel>

Parameters:

ParameterTypeRequiredDescription
filtersDocumentFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<DocumentModel> -

findOne

findOne(documentId: string): Promise<DocumentModel | null>

Parameters:

ParameterTypeRequiredDescription
documentIdstringYes

Returns:

Promise<DocumentModel \| null> -

count

count(filters: DocumentFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersDocumentFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<DocumentModel, CreateDocumentInput>

Returns:

MutationOperator<DocumentModel, CreateDocumentInput> -

updateMutation

updateMutation(): MutationOperator<DocumentModel, UpdateDocumentInput>

Returns:

MutationOperator<DocumentModel, UpdateDocumentInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

approveMutation

approveMutation(): MutationOperator<DocumentModel, { id: string; userId: string; }>

Returns:

MutationOperator<DocumentModel, { id: string; userId: string; }> -

FinAccountOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: FinAccountFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<FinAccountModel>

Parameters:

ParameterTypeRequiredDescription
filtersFinAccountFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<FinAccountModel> -

findOne

findOne(accountId: string): Promise<FinAccountModel | null>

Parameters:

ParameterTypeRequiredDescription
accountIdstringYes

Returns:

Promise<FinAccountModel \| null> -

count

count(filters: FinAccountFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersFinAccountFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<FinAccountModel, CreateFinAccountInput>

Returns:

MutationOperator<FinAccountModel, CreateFinAccountInput> -

updateMutation

updateMutation(): MutationOperator<FinAccountModel, UpdateFinAccountInput>

Returns:

MutationOperator<FinAccountModel, UpdateFinAccountInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

FinBudgetOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: FinBudgetFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<BudgetModel>

Parameters:

ParameterTypeRequiredDescription
filtersFinBudgetFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<BudgetModel> -

findOne

findOne(budgetId: string): Promise<BudgetModel | null>

Parameters:

ParameterTypeRequiredDescription
budgetIdstringYes

Returns:

Promise<BudgetModel \| null> -

count

count(filters: FinBudgetFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersFinBudgetFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<BudgetModel, CreateFinBudgetInput>

Returns:

MutationOperator<BudgetModel, CreateFinBudgetInput> -

updateMutation

updateMutation(): MutationOperator<BudgetModel, UpdateFinBudgetInput>

Returns:

MutationOperator<BudgetModel, UpdateFinBudgetInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

FinCategoryOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: FinCategoryFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<FinCategoryModel>

Parameters:

ParameterTypeRequiredDescription
filtersFinCategoryFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<FinCategoryModel> -

findOne

findOne(categoryId: string): Promise<FinCategoryModel | null>

Parameters:

ParameterTypeRequiredDescription
categoryIdstringYes

Returns:

Promise<FinCategoryModel \| null> -

count

count(filters: FinCategoryFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersFinCategoryFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<FinCategoryModel, CreateFinCategoryInput>

Returns:

MutationOperator<FinCategoryModel, CreateFinCategoryInput> -

updateMutation

updateMutation(): MutationOperator<FinCategoryModel, UpdateFinCategoryInput>

Returns:

MutationOperator<FinCategoryModel, UpdateFinCategoryInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

FinIncomeStatementOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: FinIncomeStatementFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<FinIncomeStatementModel>

Parameters:

ParameterTypeRequiredDescription
filtersFinIncomeStatementFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<FinIncomeStatementModel> -

findOne

findOne(statementId: string): Promise<FinIncomeStatementModel | null>

Parameters:

ParameterTypeRequiredDescription
statementIdstringYes

Returns:

Promise<FinIncomeStatementModel \| null> -

count

count(filters: FinIncomeStatementFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersFinIncomeStatementFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<FinIncomeStatementModel, CreateFinIncomeStatementInput>

Returns:

MutationOperator<FinIncomeStatementModel, CreateFinIncomeStatementInput> -

updateMutation

updateMutation(): MutationOperator<FinIncomeStatementModel, UpdateFinIncomeStatementInput>

Returns:

MutationOperator<FinIncomeStatementModel, UpdateFinIncomeStatementInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

FinScheduledTransactionOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: FinScheduledTransactionFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<FinScheduledTransactionModel>

Parameters:

ParameterTypeRequiredDescription
filtersFinScheduledTransactionFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<FinScheduledTransactionModel> -

findOne

findOne(scheduledTransactionId: string): Promise<FinScheduledTransactionModel | null>

Parameters:

ParameterTypeRequiredDescription
scheduledTransactionIdstringYes

Returns:

Promise<FinScheduledTransactionModel \| null> -

count

count(filters: FinScheduledTransactionFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersFinScheduledTransactionFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<FinScheduledTransactionModel, CreateFinScheduledTransactionInput>

Returns:

MutationOperator<FinScheduledTransactionModel, CreateFinScheduledTransactionInput> -

updateMutation

updateMutation(): MutationOperator<FinScheduledTransactionModel, UpdateFinScheduledTransactionInput>

Returns:

MutationOperator<FinScheduledTransactionModel, UpdateFinScheduledTransactionInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

FinTransactionOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: FinTransactionFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<FinTransactionModel>

Parameters:

ParameterTypeRequiredDescription
filtersFinTransactionFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<FinTransactionModel> -

findOne

findOne(transactionId: string): Promise<FinTransactionModel | null>

Parameters:

ParameterTypeRequiredDescription
transactionIdstringYes

Returns:

Promise<FinTransactionModel \| null> -

count

count(filters: FinTransactionFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersFinTransactionFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<FinTransactionModel, CreateFinTransactionInput>

Returns:

MutationOperator<FinTransactionModel, CreateFinTransactionInput> -

updateMutation

updateMutation(): MutationOperator<FinTransactionModel, UpdateFinTransactionInput>

Returns:

MutationOperator<FinTransactionModel, UpdateFinTransactionInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

FlowOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: FlowFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<FlowModel>

Parameters:

ParameterTypeRequiredDescription
filtersFlowFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<FlowModel> -

findOne

findOne(flowId: string): Promise<FlowModel | null>

Parameters:

ParameterTypeRequiredDescription
flowIdstringYes

Returns:

Promise<FlowModel \| null> -

count

count(filters: FlowFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersFlowFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<FlowModel, CreateFlowInput>

Returns:

MutationOperator<FlowModel, CreateFlowInput> -

updateMutation

updateMutation(): MutationOperator<FlowModel, UpdateFlowInput>

Returns:

MutationOperator<FlowModel, UpdateFlowInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

GoalOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: GoalFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<GoalModel>

Parameters:

ParameterTypeRequiredDescription
filtersGoalFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<GoalModel> -

findOne

findOne(goalId: string): Promise<GoalModel | null>

Parameters:

ParameterTypeRequiredDescription
goalIdstringYes

Returns:

Promise<GoalModel \| null> -

count

count(filters: GoalFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersGoalFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<GoalModel, CreateGoalInput>

Returns:

MutationOperator<GoalModel, CreateGoalInput> -

updateMutation

updateMutation(): MutationOperator<GoalModel, UpdateGoalInput>

Returns:

MutationOperator<GoalModel, UpdateGoalInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

InitiativeOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: InitiativeFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<InitiativeModel>

Parameters:

ParameterTypeRequiredDescription
filtersInitiativeFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<InitiativeModel> -

findOne

findOne(initiativeId: string): Promise<InitiativeModel | null>

Parameters:

ParameterTypeRequiredDescription
initiativeIdstringYes

Returns:

Promise<InitiativeModel \| null> -

count

count(filters: InitiativeFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersInitiativeFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<InitiativeModel, CreateInitiativeInput>

Returns:

MutationOperator<InitiativeModel, CreateInitiativeInput> -

updateMutation

updateMutation(): MutationOperator<InitiativeModel, UpdateInitiativeInput>

Returns:

MutationOperator<InitiativeModel, UpdateInitiativeInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

MarketAnalysisOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: MarketAnalysisFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<MarketAnalysisModel>

Parameters:

ParameterTypeRequiredDescription
filtersMarketAnalysisFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<MarketAnalysisModel> -

findOne

findOne(analysisId: string): Promise<MarketAnalysisModel | null>

Parameters:

ParameterTypeRequiredDescription
analysisIdstringYes

Returns:

Promise<MarketAnalysisModel \| null> -

createMutation

createMutation(): MutationOperator<MarketAnalysisModel, CreateMarketAnalysisInput>

Returns:

MutationOperator<MarketAnalysisModel, CreateMarketAnalysisInput> -

updateMutation

updateMutation(): MutationOperator<MarketAnalysisModel, UpdateMarketAnalysisInput>

Returns:

MutationOperator<MarketAnalysisModel, UpdateMarketAnalysisInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

MessageOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: MessageFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<MessageModel>

Parameters:

ParameterTypeRequiredDescription
filtersMessageFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<MessageModel> -

findOne

findOne(messageId: string): Promise<MessageModel | null>

Parameters:

ParameterTypeRequiredDescription
messageIdstringYes

Returns:

Promise<MessageModel \| null> -

count

count(filters: MessageFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersMessageFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<MessageModel, CreateMessageInput>

Returns:

MutationOperator<MessageModel, CreateMessageInput> -

updateMutation

updateMutation(): MutationOperator<MessageModel, UpdateMessageInput>

Returns:

MutationOperator<MessageModel, UpdateMessageInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

MilestoneOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: MilestoneFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<MilestoneModel>

Parameters:

ParameterTypeRequiredDescription
filtersMilestoneFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<MilestoneModel> -

findOne

findOne(milestoneId: string): Promise<MilestoneModel | null>

Parameters:

ParameterTypeRequiredDescription
milestoneIdstringYes

Returns:

Promise<MilestoneModel \| null> -

count

count(filters: MilestoneFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersMilestoneFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<MilestoneModel, CreateMilestoneInput>

Returns:

MutationOperator<MilestoneModel, CreateMilestoneInput> -

updateMutation

updateMutation(): MutationOperator<MilestoneModel, UpdateMilestoneInput>

Returns:

MutationOperator<MilestoneModel, UpdateMilestoneInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

completeMutation

completeMutation(): MutationOperator<MilestoneModel, string>

Returns:

MutationOperator<MilestoneModel, string> -

OpportunityOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: OpportunityFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<OpportunityModel>

Parameters:

ParameterTypeRequiredDescription
filtersOpportunityFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<OpportunityModel> -

findOne

findOne(opportunityId: string): Promise<OpportunityModel | null>

Parameters:

ParameterTypeRequiredDescription
opportunityIdstringYes

Returns:

Promise<OpportunityModel \| null> -

count

count(filters: OpportunityFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersOpportunityFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<OpportunityModel, CreateOpportunityInput>

Returns:

MutationOperator<OpportunityModel, CreateOpportunityInput> -

updateMutation

updateMutation(): MutationOperator<OpportunityModel, UpdateOpportunityInput>

Returns:

MutationOperator<OpportunityModel, UpdateOpportunityInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

OrgOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: OrgFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<OrgModel>

Parameters:

ParameterTypeRequiredDescription
filtersOrgFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<OrgModel> -

findOne

findOne(orgId: string): Promise<OrgModel | null>

Parameters:

ParameterTypeRequiredDescription
orgIdstringYes

Returns:

Promise<OrgModel \| null> -

count

count(filters: OrgFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersOrgFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<OrgModel, CreateOrgInput>

Returns:

MutationOperator<OrgModel, CreateOrgInput> -

updateMutation

updateMutation(): MutationOperator<OrgModel, UpdateOrgInput>

Returns:

MutationOperator<OrgModel, UpdateOrgInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

ProcessExecutionOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: ProcessExecutionFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<ProcessExecutionModel>

Parameters:

ParameterTypeRequiredDescription
filtersProcessExecutionFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<ProcessExecutionModel> -

findOne

findOne(executionId: string): Promise<ProcessExecutionModel | null>

Parameters:

ParameterTypeRequiredDescription
executionIdstringYes

Returns:

Promise<ProcessExecutionModel \| null> -

findByCorrelationId

findByCorrelationId(correlationId: string): Promise<ProcessExecutionModel[]>

Parameters:

ParameterTypeRequiredDescription
correlationIdstringYes

Returns:

Promise<ProcessExecutionModel[]> -

count

count(filters: ProcessExecutionFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersProcessExecutionFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<ProcessExecutionModel, CreateProcessExecutionInput>

Returns:

MutationOperator<ProcessExecutionModel, CreateProcessExecutionInput> -

updateMutation

updateMutation(): MutationOperator<ProcessExecutionModel, UpdateProcessExecutionInput>

Returns:

MutationOperator<ProcessExecutionModel, UpdateProcessExecutionInput> -

startMutation

startMutation(): MutationOperator<ProcessExecutionModel, { id: string; currentStepId: string; }>

Returns:

MutationOperator<ProcessExecutionModel, { id: string; currentStepId: string; }> -

completeMutation

completeMutation(): MutationOperator<ProcessExecutionModel, { id: string; outputs?: Record<string, unknown>; }>

Returns:

MutationOperator<ProcessExecutionModel, { id: string; outputs?: Record<string, unknown>; }> -

failMutation

failMutation(): MutationOperator<ProcessExecutionModel, { id: string; error: ProcessExecutionModel["error"]; }>

Returns:

MutationOperator<ProcessExecutionModel, { id: string; error: ProcessExecutionModel["error"]; }> -

pauseMutation

pauseMutation(): MutationOperator<ProcessExecutionModel, { id: string; resumeAt?: string; }>

Returns:

MutationOperator<ProcessExecutionModel, { id: string; resumeAt?: string; }> -

resumeMutation

resumeMutation(): MutationOperator<ProcessExecutionModel, string>

Returns:

MutationOperator<ProcessExecutionModel, string> -

cancelMutation

cancelMutation(): MutationOperator<ProcessExecutionModel, string>

Returns:

MutationOperator<ProcessExecutionModel, string> -

recordStepMutation

recordStepMutation(): MutationOperator<ProcessExecutionModel, RecordStepExecutionInput>

Returns:

MutationOperator<ProcessExecutionModel, RecordStepExecutionInput> -

updateProgressMutation

updateProgressMutation(): MutationOperator<ProcessExecutionModel, { id: string; progress: number; }>

Returns:

MutationOperator<ProcessExecutionModel, { id: string; progress: number; }> -

retryMutation

retryMutation(): MutationOperator<ProcessExecutionModel, string>

Returns:

MutationOperator<ProcessExecutionModel, string> -

archiveMutation

archiveMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

ProcessOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: ProcessFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<ProcessModel>

Parameters:

ParameterTypeRequiredDescription
filtersProcessFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<ProcessModel> -

findOne

findOne(processId: string): Promise<ProcessModel | null>

Parameters:

ParameterTypeRequiredDescription
processIdstringYes

Returns:

Promise<ProcessModel \| null> -

findByName

findByName(orgId: string, workspaceId: string, name: string): Promise<ProcessModel | null>

Parameters:

ParameterTypeRequiredDescription
orgIdstringYes
workspaceIdstringYes
namestringYes

Returns:

Promise<ProcessModel \| null> -

count

count(filters: ProcessFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersProcessFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<ProcessModel, CreateProcessInput>

Returns:

MutationOperator<ProcessModel, CreateProcessInput> -

updateMutation

updateMutation(): MutationOperator<ProcessModel, UpdateProcessInput>

Returns:

MutationOperator<ProcessModel, UpdateProcessInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

publishMutation

publishMutation(): MutationOperator<ProcessModel, string>

Returns:

MutationOperator<ProcessModel, string> -

deprecateMutation

deprecateMutation(): MutationOperator<ProcessModel, { id: string; reason?: string; replacedBy?: string; }>

Returns:

MutationOperator<ProcessModel, { id: string; reason?: string; replacedBy?: string; }> -

addStepMutation

addStepMutation(): MutationOperator<ProcessModel, { processId: string; stepId: string; position?: number; }>

Returns:

MutationOperator<ProcessModel, { processId: string; stepId: string; position?: number; }> -

removeStepMutation

removeStepMutation(): MutationOperator<ProcessModel, { processId: string; stepId: string; }>

Returns:

MutationOperator<ProcessModel, { processId: string; stepId: string; }> -

ProcessStepOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: ProcessStepFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<ProcessStepModel>

Parameters:

ParameterTypeRequiredDescription
filtersProcessStepFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<ProcessStepModel> -

findOne

findOne(stepId: string): Promise<ProcessStepModel | null>

Parameters:

ParameterTypeRequiredDescription
stepIdstringYes

Returns:

Promise<ProcessStepModel \| null> -

findByProcess

findByProcess(processId: string): Promise<ProcessStepModel[]>

Parameters:

ParameterTypeRequiredDescription
processIdstringYes

Returns:

Promise<ProcessStepModel[]> -

count

count(filters: ProcessStepFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersProcessStepFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<ProcessStepModel, CreateProcessStepInput>

Returns:

MutationOperator<ProcessStepModel, CreateProcessStepInput> -

updateMutation

updateMutation(): MutationOperator<ProcessStepModel, UpdateProcessStepInput>

Returns:

MutationOperator<ProcessStepModel, UpdateProcessStepInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

enableMutation

enableMutation(): MutationOperator<ProcessStepModel, string>

Returns:

MutationOperator<ProcessStepModel, string> -

disableMutation

disableMutation(): MutationOperator<ProcessStepModel, string>

Returns:

MutationOperator<ProcessStepModel, string> -

updatePositionMutation

updatePositionMutation(): MutationOperator<ProcessStepModel, { id: string; position: StepPosition; }>

Returns:

MutationOperator<ProcessStepModel, { id: string; position: StepPosition; }> -

reorderMutation

reorderMutation(): MutationOperator<ProcessStepModel[], { processId: string; stepIds: string[]; }>

Returns:

MutationOperator<ProcessStepModel[], { processId: string; stepIds: string[]; }> -

ProductOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: ProductFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<ProductModel>

Parameters:

ParameterTypeRequiredDescription
filtersProductFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<ProductModel> -

findOne

findOne(productId: string): Promise<ProductModel | null>

Parameters:

ParameterTypeRequiredDescription
productIdstringYes

Returns:

Promise<ProductModel \| null> -

count

count(filters: ProductFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersProductFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<ProductModel, CreateProductInput>

Returns:

MutationOperator<ProductModel, CreateProductInput> -

updateMutation

updateMutation(): MutationOperator<ProductModel, UpdateProductInput>

Returns:

MutationOperator<ProductModel, UpdateProductInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

ProjectOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: ProjectFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<ProjectModel>

Parameters:

ParameterTypeRequiredDescription
filtersProjectFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<ProjectModel> -

findOne

findOne(projectId: string): Promise<ProjectModel | null>

Parameters:

ParameterTypeRequiredDescription
projectIdstringYes

Returns:

Promise<ProjectModel \| null> -

count

count(filters: ProjectFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersProjectFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<ProjectModel, CreateProjectInput>

Returns:

MutationOperator<ProjectModel, CreateProjectInput> -

updateMutation

updateMutation(): MutationOperator<ProjectModel, UpdateProjectInput>

Returns:

MutationOperator<ProjectModel, UpdateProjectInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

completeMutation

completeMutation(): MutationOperator<ProjectModel, string>

Returns:

MutationOperator<ProjectModel, string> -

RoadmapOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: RoadmapFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<RoadmapModel>

Parameters:

ParameterTypeRequiredDescription
filtersRoadmapFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<RoadmapModel> -

findOne

findOne(roadmapId: string): Promise<RoadmapModel | null>

Parameters:

ParameterTypeRequiredDescription
roadmapIdstringYes

Returns:

Promise<RoadmapModel \| null> -

count

count(filters: RoadmapFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersRoadmapFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<RoadmapModel, CreateRoadmapInput>

Returns:

MutationOperator<RoadmapModel, CreateRoadmapInput> -

updateMutation

updateMutation(): MutationOperator<RoadmapModel, UpdateRoadmapInput>

Returns:

MutationOperator<RoadmapModel, UpdateRoadmapInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

SessionOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: SessionFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<SessionModel>

Parameters:

ParameterTypeRequiredDescription
filtersSessionFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<SessionModel> -

findOne

findOne(sessionId: string): Promise<SessionModel | null>

Parameters:

ParameterTypeRequiredDescription
sessionIdstringYes

Returns:

Promise<SessionModel \| null> -

count

count(filters: SessionFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersSessionFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<SessionModel, CreateSessionInput>

Returns:

MutationOperator<SessionModel, CreateSessionInput> -

updateMutation

updateMutation(): MutationOperator<SessionModel, UpdateSessionInput>

Returns:

MutationOperator<SessionModel, UpdateSessionInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

TaskOperator

Framework-agnostic task operations

Provides query and mutation operators for tasks that work in any environment. Use this directly in Node.js scripts or wrap with framework hooks (React, Vue, etc.).

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

Create a query operator for tasks

Returns a QueryOperator that can be used imperatively (exec) or reactively (observable).

query(filters: TaskFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<TaskModel>

Parameters:

ParameterTypeRequiredDescription
filtersTaskFiltersYes- Task filters to apply
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo- Optional query options (sort, limit, skip)

Returns:

QueryOperator<TaskModel> - QueryOperator instance for tasks

findOne

Find a single task by ID

findOne(taskId: string): Promise<TaskModel | null>

Parameters:

ParameterTypeRequiredDescription
taskIdstringYes- Task ID to find

Returns:

Promise<TaskModel \| null> - Promise resolving to task or null if not found

count

Count tasks matching the given filters

count(filters: TaskFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersTaskFiltersYes- Task filters to apply

Returns:

Promise<number> - Promise resolving to count of matching tasks

createMutation

Create a mutation operator for creating tasks

createMutation(): MutationOperator<TaskModel, CreateTaskInput>

Returns:

MutationOperator<TaskModel, CreateTaskInput> - MutationOperator for task creation

updateMutation

Create a mutation operator for updating tasks

updateMutation(): MutationOperator<TaskModel, UpdateTaskInput>

Returns:

MutationOperator<TaskModel, UpdateTaskInput> - MutationOperator for task updates

deleteMutation

Create a mutation operator for deleting tasks (soft delete)

Marks task as archived rather than physically deleting it.

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> - MutationOperator for task deletion

completeMutation

Create a mutation operator for completing tasks

Sets task status to 'Complete' and marks as completed.

completeMutation(): MutationOperator<TaskModel, string>

Returns:

MutationOperator<TaskModel, string> - MutationOperator for task completion

Examples:

// Node.js script usage
const taskOps = new TaskOperator(db);
const query = taskOps.query({ orgId: 'org_123', status: 'In Progress' });
const tasks = await query.exec();

// Create task
const mutation = taskOps.createMutation();
const newTask = await mutation.execute({
  title: 'New Task',
  description: 'Task description',
  orgId: 'org_123',
  userId: 'user_456',
  projectId: 'proj_789',
  milestoneId: 'mile_101'
});

TemplateOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: TemplateFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<TemplateModel>

Parameters:

ParameterTypeRequiredDescription
filtersTemplateFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<TemplateModel> -

findOne

findOne(templateId: string): Promise<TemplateModel | null>

Parameters:

ParameterTypeRequiredDescription
templateIdstringYes

Returns:

Promise<TemplateModel \| null> -

count

count(filters: TemplateFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersTemplateFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<TemplateModel, CreateTemplateInput>

Returns:

MutationOperator<TemplateModel, CreateTemplateInput> -

updateMutation

updateMutation(): MutationOperator<TemplateModel, UpdateTemplateInput>

Returns:

MutationOperator<TemplateModel, UpdateTemplateInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

TimeEntryOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: TimeEntryFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<TimeEntryModel>

Parameters:

ParameterTypeRequiredDescription
filtersTimeEntryFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<TimeEntryModel> -

findOne

findOne(timeEntryId: string): Promise<TimeEntryModel | null>

Parameters:

ParameterTypeRequiredDescription
timeEntryIdstringYes

Returns:

Promise<TimeEntryModel \| null> -

count

count(filters: TimeEntryFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersTimeEntryFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<TimeEntryModel, CreateTimeEntryInput>

Returns:

MutationOperator<TimeEntryModel, CreateTimeEntryInput> -

updateMutation

updateMutation(): MutationOperator<TimeEntryModel, UpdateTimeEntryInput>

Returns:

MutationOperator<TimeEntryModel, UpdateTimeEntryInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

UserOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: UserFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<UserModel>

Parameters:

ParameterTypeRequiredDescription
filtersUserFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<UserModel> -

findOne

findOne(userId: string): Promise<UserModel | null>

Parameters:

ParameterTypeRequiredDescription
userIdstringYes

Returns:

Promise<UserModel \| null> -

count

count(filters: UserFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersUserFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<UserModel, CreateUserInput>

Returns:

MutationOperator<UserModel, CreateUserInput> -

updateMutation

updateMutation(): MutationOperator<UserModel, UpdateUserInput>

Returns:

MutationOperator<UserModel, UpdateUserInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

VariablesOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: VariablesFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<VariablesModel>

Parameters:

ParameterTypeRequiredDescription
filtersVariablesFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<VariablesModel> -

findOne

findOne(variableId: string): Promise<VariablesModel | null>

Parameters:

ParameterTypeRequiredDescription
variableIdstringYes

Returns:

Promise<VariablesModel \| null> -

count

count(filters: VariablesFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersVariablesFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<VariablesModel, CreateVariablesInput>

Returns:

MutationOperator<VariablesModel, CreateVariablesInput> -

updateMutation

updateMutation(): MutationOperator<VariablesModel, UpdateVariablesInput>

Returns:

MutationOperator<VariablesModel, UpdateVariablesInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

WorkspaceOperator

Constructor

constructor(db: RxDatabase)

Parameters:

ParameterTypeRequiredDescription
dbRxDatabaseYes

Methods

query

query(filters: WorkspaceFilters, options?: { sort?: string; limit?: number; skip?: number; } | undefined): QueryOperator<WorkspaceModel>

Parameters:

ParameterTypeRequiredDescription
filtersWorkspaceFiltersYes
options{ sort?: string; limit?: number; skip?: number; } | undefinedNo

Returns:

QueryOperator<WorkspaceModel> -

findOne

findOne(workspaceId: string): Promise<WorkspaceModel | null>

Parameters:

ParameterTypeRequiredDescription
workspaceIdstringYes

Returns:

Promise<WorkspaceModel \| null> -

count

count(filters: WorkspaceFilters): Promise<number>

Parameters:

ParameterTypeRequiredDescription
filtersWorkspaceFiltersYes

Returns:

Promise<number> -

createMutation

createMutation(): MutationOperator<WorkspaceModel, CreateWorkspaceInput>

Returns:

MutationOperator<WorkspaceModel, CreateWorkspaceInput> -

updateMutation

updateMutation(): MutationOperator<WorkspaceModel, UpdateWorkspaceInput>

Returns:

MutationOperator<WorkspaceModel, UpdateWorkspaceInput> -

deleteMutation

deleteMutation(): MutationOperator<void, string>

Returns:

MutationOperator<void, string> -

MutationOperator

Framework-agnostic mutation operator

Wraps RxDB write operations with state management and callbacks. Works in any environment (Node.js, Browser, React Native, Electron).

Constructor

constructor(collection: RxCollection, options: MutationOptions<TData, TVariables>)

Parameters:

ParameterTypeRequiredDescription
collectionRxCollectionYes
optionsMutationOptions<TData, TVariables>Yes

Methods

execute

Execute mutation imperatively

Performs the mutation, updates state, and invokes callbacks. Returns Promise for imperative usage in scripts and CLI tools.

execute(variables: TVariables): Promise<TData>

Parameters:

ParameterTypeRequiredDescription
variablesTVariablesYes- Input variables for the mutation

Returns:

Promise<TData> - Promise resolving to mutation result data

reset

Reset mutation state to initial values

reset(): void

destroy

Cleanup and complete observables

Call this when the mutation operator is no longer needed.

destroy(): void

Examples:

// Create mutation operator
const createTask = new MutationOperator(collection, {
  mutationFn: async (col, data) => {
    await col.insert(data);
    return data;
  },
  onSuccess: (data) => console.log('Created:', data.id)
});

// Execute imperatively
const task = await createTask.execute({ title: 'New Task' });

// Or subscribe reactively
createTask.state$.subscribe(state => {
  if (state.isLoading) console.log('Saving...');
  if (state.data) console.log('Saved!');
});

QueryOperator

Framework-agnostic query operator

Wraps RxDB queries with reactive observables that work in any environment. Provides both imperative (exec) and reactive (observable) APIs.

Constructor

constructor(collection: RxCollection, options: QueryOptions<T>)

Parameters:

ParameterTypeRequiredDescription
collectionRxCollectionYes
optionsQueryOptions<T>Yes

Methods

exec

Execute query imperatively and return results as Promise

Use in Node.js scripts, CLI tools, and other imperative contexts.

exec(): Promise<T[]>

Returns:

Promise<T[]> - Promise resolving to array of documents

refetch

Refetch query results imperatively

refetch(): Promise<T[]>

Returns:

Promise<T[]> - Promise resolving to current query results

destroy

Cleanup subscriptions and complete observables

Call this when the query is no longer needed to prevent memory leaks.

destroy(): void

Examples:

// Imperative usage (Node.js, CLI)
const query = new QueryOperator(collection, { selector: { status: 'active' } });
const results = await query.exec();

// Reactive usage (UI frameworks)
query.observable.subscribe(result => {
  console.log('Data updated:', result.data);
});
Previous
Types