Class ScopeManager

Scope manager for model scoping

Index

Constructors

Methods

addScope setDefaultScope getScope hasScope removeScope clearScopes getScopeCount getAllScopes getDefaultScope applyScope getCurrentScope clearScope mergeScopeOptions

Constructors

constructor

new ScopeManager(model: ModelStatic<Model>): ScopeManager
Parameters
- model: ModelStatic<Model>
Returns ScopeManager
- Defined in models/scopes.ts:17

Methods

addScope

addScope(name: string, options: ScopeOptions): void
Add a named scope
Parameters
- name: string
- options: ScopeOptions
Returns void
- Defined in models/scopes.ts:24

setDefaultScope

setDefaultScope(options: ScopeOptions): void
Set the default scope
Parameters
- options: ScopeOptions
Returns void
- Defined in models/scopes.ts:31

getScope

getScope(name: string): ScopeOptions | undefined
Get a scope by name
Parameters
- name: string
Returns ScopeOptions | undefined
- Defined in models/scopes.ts:38

hasScope

hasScope(name: string): boolean
Check if a scope exists
Parameters
- name: string
Returns boolean
- Defined in models/scopes.ts:45

removeScope

removeScope(name: string): boolean
Remove a scope by name
Parameters
- name: string
Returns boolean
- Defined in models/scopes.ts:52

clearScopes

clearScopes(): void
Clear all named scopes

Returns void
- Defined in models/scopes.ts:63

getScopeCount

getScopeCount(): number
Get the count of defined scopes

Returns number
- Defined in models/scopes.ts:70

getAllScopes

getAllScopes(): Map<string, ScopeOptions>
Get all defined scopes

Returns Map<string, ScopeOptions>
- Defined in models/scopes.ts:77

getDefaultScope

getDefaultScope(): ScopeOptions | null
Get the default scope

Returns ScopeOptions | null
- Defined in models/scopes.ts:84

applyScope

applyScope(scopeName: string, options?: FindOptions): FindOptions
Apply a scope to options
Parameters
- scopeName: string
- options: FindOptions = {}
Returns FindOptions
- Defined in models/scopes.ts:91

getCurrentScope

getCurrentScope(): string | null
Get the current active scope name

Returns string | null
- Defined in models/scopes.ts:106

clearScope

clearScope(): void
Clear the current scope

Returns void
- Defined in models/scopes.ts:113

mergeScopeOptions

mergeScopeOptions(options: FindOptions, scope: ScopeOptions): FindOptions
Merge scope options with query options
Parameters
- options: FindOptions
- scope: ScopeOptions
Returns FindOptions
- Defined in models/scopes.ts:120