Skip to content

fix(core): Improve type declaration for model validation functions #14

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

Open
martinslota wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(core): Improve type declaration for model validation functions #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a9a91dc
Provide more accurate type declarations for model validation functions
martinslota Nov 1, 2024
c1c11ee
Fix up model option merging
martinslota Nov 1, 2024
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
10 changes: 5 additions & 5 deletions packages/core/src/model-definition.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ export class ModelDefinition<M extends Model = Model> {

// TODO: deep freeze this.options
// caution: mergeModelOptions mutates its first input
this.options = mergeModelOptions(
this.options = mergeModelOptions<M>(
// default options
{
noPrimaryKey: false,
Expand Down Expand Up @@ -959,11 +959,11 @@ function banReferenceModel<T>(reference: T): T {
* @param options
* @param overrideOnConflict
*/
export function mergeModelOptions(
existingModelOptions: ModelOptions,
options: ModelOptions,
export function mergeModelOptions<M extends Model>(
existingModelOptions: ModelOptions<M>,
options: ModelOptions<M>,
overrideOnConflict: boolean,
): ModelOptions {
): ModelOptions<M> {
// merge-able: scopes, indexes
for (const [optionName, optionValue] of Object.entries(options) as Array<
[keyof ModelOptions, any]
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/model.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2115,7 +2115,7 @@ export interface ModelOptions<M extends Model = Model> {
/**
* Custom validation functions run on all instances of the model.
*/
[name: string]: (value: unknown) => boolean;
[name: string]: ((this: M) => void) | ((this: M, callback: (err: unknown) => void) => void);
}
| undefined;

Expand Down
Loading