Skip to content

feat: create an interface to export and use in KDM #758

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 12, 2025
Merged

feat: create an interface to export and use in KDM #758

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 25 additions & 23 deletions src/controllers/Document.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -716,29 +716,7 @@ export class DocumentController extends BaseController {
query: JSONObject,
changes: Partial<TKDocumentContent>,
options: ArgsDocumentControllerUpdateByQuery = {}
): Promise<{
/**
* Array of successfully updated documents
*/
successes: KDocument<TKDocumentContent>[];
/**
* Array of failed creation
*/
errors: Array<{
/**
* Document that cause the error
*/
document: KDocument<TKDocumentContent>;
/**
* HTTP error status
*/
status: number;
/**
* Human readable reason
*/
reason: string;
}>;
}> {
): Promise<UpdateByQueryResponse<TKDocumentContent>> {
const request = {
action: "updateByQuery",
body: { changes, query },
Expand Down Expand Up @@ -940,3 +918,27 @@ export interface ArgsDocumentControllerUpsert<TKDocumentContent>
}

export type ArgsDocumentControllerValidate = ArgsDefault;

export interface UpdateByQueryResponse<TKDocumentContent> {
/**
* Array of successfully updated documents
*/
successes: KDocument<TKDocumentContent>[];
/**
* Array of failed creation
*/
errors: Array<{
/**
* Document that cause the error
*/
document: KDocument<TKDocumentContent>;
/**
* HTTP error status
*/
status: number;
/**
* Human readable reason
*/
reason: string;
}>;
}