diff --git a/src/scopes/scope-options.ts b/src/scopes/scope-options.ts index 5f77a461..6a56be9c 100644 --- a/src/scopes/scope-options.ts +++ b/src/scopes/scope-options.ts @@ -13,5 +13,18 @@ export interface ScopeOptionsGetters { } export type DefaultScopeGetter = () => FindOptions; + +/** + * This is the type that you should use if adding a new set of scopes + * @example + * const myModelScopes: ScopesOptionsGetter = () => ({ + * scopeOne: FindOptions & IncludeOptions { + * return {...} + * }, + * scopeTwo: FindOptions { + * return {...} + * } + * }) + */ export type ScopesOptionsGetter = () => { [sopeName: string]: ScopesOptions }; export type ScopesOptions = FindOptions | ((...args: any[]) => FindOptions);