Skip to content

Improve ModelObject type #2299

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

Closed
wants to merge 1 commit into from
Closed

Improve ModelObject type #2299

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

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions typings/objection/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,26 @@ declare namespace Objection {
[K in DataPropertyNames<T>]: T[K];
};

/**
* Returns keys that have function as their type.
*/
type KeysWithFunctionType<T> = {
[K in keyof T]: T[K] extends Function ? K : never;
}[keyof T];
Copy link
Collaborator

@lehni lehni Apr 16, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the reverse of the already existing NonFunctionPropertyNames, I think the name should reflect that:

FunctionPropertyNames

/**
* Like ModelObject, but preserves information about optionality.
*
* Removes keys that:
* - start with '$'
* - are 'QueryBuilderType'
* - have function type
*/
export type ModelProperties<T extends Model> = Pick<
T,
Exclude<keyof T, `$${string}` | 'QueryBuilderType' | KeysWithFunctionType<T>>
>;

/**
* Any object that has some of the properties of model class T match this type.
*/
Expand Down