@istock/iswork / Exports

@istock/iswork

Table of contents

Enumerations

• ECondOperator
• EDecoratorCallbackType
• EDecoratorType
• EDriverConnectStatus
• EMessageCmdAction
• EMessageStatus
• EMethodNameFilter

Classes

• Application
• ApplicationContext
• BaseModel
• DataSource
• MessageChannelAdapter
• MessageIterator
• MessageSSE
• Observable
• QueryBuilder
• Repository
• RepositoryManager

Interfaces

• BaseProvider
• IAnyClass
• IClassProvider
• IDomainClass
• IFactoryProvider
• IMessageHandler
• IObserver
• IParamOption
• IParsedRequestParams
• IPartialQueryBuilderOptions
• IQueryParamsOptions
• IValueProvider

Type Aliases

• IParamsOptions
• TAnyMetadata
• TAnyObj
• TAnyObject
• TApplicationContextOptions
• TApplicationEventOptions
• TApplicationOptions
• TCmdpAddressInfo
• TCmdpInfo
• TCmdpMessage
• TCmdpMeta
• TCmdpMetaValue
• TCmdpOptions
• TCmdpPayload
• TCmdpResolveInfo
• TComparisonOperator
• TController
• TControllerMetadata
• TControllerMethodCmdRoute
• TControllerMethodCmdRouteArguments
• TControllerMethodCmdRouteMetadata
• TControllerMethodCmdRouteOptions
• TControllerMethodCmdRouteOptionsMetadata
• TControllerMethodComponentAccept
• TControllerMethodComponentMetadata
• TControllerMethodComponentOutput
• TControllerMethodComponentResponse
• TControllerMethodMessageHandlerMetadata
• TControllerMethodMessageMetadata
• TControllerMethodMetadata
• TControllerMethodParamFiledMetadata
• TControllerMethodParamMetaMetadata
• TControllerMethodParamMetadata
• TControllerMethodParamPayloadMetadata
• TControllerMethodReturnMetadata
• TDataSourceAllOptions
• TDataSourceCommonOptions
• TDataSourceFetchOptions
• TDataSourceIndexedDBOptions
• TDataSourceMemoryDBOptions
• TDataSourceType
• TDecoratorAllColumnMetadata
• TDecoratorCallbackCacheValue
• TDecoratorColumnMetadata
• TDecoratorColumnOptions
• TDecoratorIndexMetadata
• TDecoratorIndexOptions
• TDecoratorModelMetadata
• TDecoratorModelOptions
• TDecoratorPrimaryColumnMetadata
• TDecoratorPrimaryColumnOptions
• TDeprecatedCondOperator
• TDomainControllerMetadata
• TDomainControllerMetadataMap
• TDomainMetadata
• TDomainOptions
• TFetchSSEMessage
• TFetchWrapOptions
• TIdAnyObject
• TInjectionToken
• TMessageIteratorData
• TMessageSSEIteratorData
• TMessageSSEOptions
• TMetadataExport
• TMetadataImport
• TMiddleware
• TModelCreate
• TModelCreateNoId
• TModelData
• TModelMethod
• TModelOnlyId
• TModelPartialData
• TModelRequireData
• TModelType
• TModelUpdate
• TOrmQuery
• TParamOptionType
• TProvider
• TProviderClass
• TProviderMeta
• TQueryBuilderOptions
• TQueryBuilderOptionsKeys
• TQueryFields
• TQueryFilter
• TQueryFilterArr
• TQueryJoin
• TQueryJoinArr
• TQuerySort
• TQuerySortArr
• TQuerySortOperator
• TSCondition
• TSConditionAND
• TSConditionKey
• TSField
• TSFieldOperator
• TSFields
• TSFiledValues
• TSPrimitivesVal
• TScanClassMetadata
• TScanPropertyMetadata
• TScanPropertyMetadataMap
• TScanPropertyMetadataMapValue
• TSubscribeCallback
• TUnSubscribe

Variables

• CONTROLLER_METADATA
• CONTROLLER_METHOD_CMDROUTE_METADATA
• CONTROLLER_METHOD_COMPONENT_METADATA
• CONTROLLER_METHOD_MESSAGE_HANDLER_METADATA
• CONTROLLER_METHOD_MESSAGE_METADATA
• CONTROLLER_METHOD_METADATA
• CONTROLLER_METHOD_NAME_METADATA
• CONTROLLER_METHOD_PARAM_CMDROUTEARGUMENTS_METADATA
• CONTROLLER_METHOD_PARAM_CMDROUTEOPTIONS_METADATA
• CONTROLLER_METHOD_PARAM_FILED_METADATA
• CONTROLLER_METHOD_PARAM_META_METADATA
• CONTROLLER_METHOD_PARAM_PAYLOAD_METADATA
• CONTROLLER_METHOD_RETURN_METADATA
• DESIGN_PARAMTYPES
• DOMAIN_METADATA
• Decorator
• GLOBAL_DOMAIN_METADATA
• GLOBAL_SCOPE
• IOC_INJECT
• IOC_INJECTABLE
• comparisonOperatorsList
• decoratorRegister
• deprecatedComparisonOperatorsList
• sortOrdersList

Functions

• CmdRoute
• CmdRouteArguments
• CmdRouteOptions
• Column
• Component
• Controller
• Domain
• Field
• Global
• Index
• Inject
• Injectable
• Message
• MessageHandler
• Meta
• Method
• Model
• Payload
• PrimaryColumn
• Return
• getColumnMetadata
• getIndexMetadata
• getInjectMetadata
• getInjectableMetadata
• getModelMetadata
• getPrimaryColumnMetadata
• registerAndWrapHandler

Type Aliases

IParamsOptions

Ƭ IParamsOptions: Record<string, IParamOption>

Defined in

src/packages/iswork/src/orm/interfaces/query-builder.ts:13

---

TAnyMetadata

Ƭ TAnyMetadata<T>: Record<string | symbol, T>

Type parameters

Name	Type
T	unknown

Defined in

src/packages/iswork/src/orm/types/any-object.ts:2

---

TAnyObj

Ƭ TAnyObj<T>: Record<string | symbol, T>

Type parameters

Name	Type
T	unknown

Defined in

src/packages/iswork/src/orm/types/any-object.ts:5

---

TAnyObject

Ƭ TAnyObject<T>: Record<string | symbol, T>

Type parameters

Name	Type
T	any

Defined in

src/packages/iswork/src/types/any-object.ts:1

---

TApplicationContextOptions

Ƭ TApplicationContextOptions: Object

Type declaration

Name	Type
name?	string

Defined in

src/packages/iswork/src/types/context.ts:1

---

TApplicationEventOptions

Ƭ TApplicationEventOptions: Object

Type declaration

Name	Type
emit	(message: unknown, options?: { targetOrigin?: string ; transfer?: Transferable[] }) => void

Defined in

src/packages/iswork/src/types/application.ts:3

---

TApplicationOptions

Ƭ TApplicationOptions: { domainPath: string ; middlewares: TMiddleware[] } & TApplicationEventOptions

Defined in

src/packages/iswork/src/types/application.ts:7

---

TCmdpAddressInfo

Ƭ TCmdpAddressInfo: Object

Type declaration

Name	Type
controller	string
domains	string[]
method	string
port	string
protocol?	string
user	string

Defined in

src/packages/iswork/src/types/cmdp.ts:22

---

TCmdpInfo

Ƭ TCmdpInfo: { address: string ; meta?: TCmdpMeta ; payload?: TCmdpPayload ; protocol: string ; returnMeta?: TCmdpMeta ; returnPayload?: TCmdpPayload } & TCmdpAddressInfo

Defined in

src/packages/iswork/src/types/cmdp.ts:31

---

TCmdpMessage

Ƭ TCmdpMessage<Payload>: Object

Type parameters

Name	Type
Payload	TCmdpPayload

Type declaration

Name	Type
address	string
meta?	TCmdpMeta
payload?	Payload

Defined in

src/packages/iswork/src/types/cmdp.ts:16

---

TCmdpMeta

Ƭ TCmdpMeta: { [k: string]: TCmdpMetaValue; status?: string | number } | null

Defined in

src/packages/iswork/src/types/cmdp.ts:9

---

TCmdpMetaValue

Ƭ TCmdpMetaValue: string | number | boolean | undefined | null

Defined in

src/packages/iswork/src/types/cmdp.ts:1

---

TCmdpOptions

Ƭ TCmdpOptions: Object

Type declaration

Name	Type
protocol?	string

Defined in

src/packages/iswork/src/types/cmdp.ts:40

---

TCmdpPayload

Ƭ TCmdpPayload: Record<string, any> | TCmdpMetaValue

Defined in

src/packages/iswork/src/types/cmdp.ts:14

---

TCmdpResolveInfo

Ƭ TCmdpResolveInfo: Object

Type declaration

Name	Type
controller	string
method	string
subDomain	string

Defined in

src/packages/iswork/src/types/cmdp.ts:3

---

TComparisonOperator

Ƭ TComparisonOperator: TDeprecatedCondOperator | keyof TSFieldOperator

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:90

---

TController

Ƭ TController<T>: IAnyClass<T>

Type parameters

Name	Type
T	unknown

Defined in

src/packages/iswork/src/types/controller.ts:3

---

TControllerMetadata

Ƭ TControllerMetadata: Object

Type declaration

Name	Type
alias?	string | string[]
component?	TControllerMethodComponentMetadata
middlewares?	TMiddleware[]
version?	string

Defined in

src/packages/iswork/src/types/controller.ts:5

---

TControllerMethodCmdRoute

Ƭ TControllerMethodCmdRoute: Object

Type declaration

Name	Type
arguments?	TControllerMethodCmdRouteOptions[]
cmd	string
description?	string
example?	string
name	string
options?	Record<string, TControllerMethodCmdRouteOptions>
remarks?	string
shortDescription?	string
source?	{ title?: string ; url?: string }
source.title?	string
source.url?	string
subcommand?	TControllerMethodCmdRoute
usage?	string

Defined in

src/packages/iswork/src/types/controller.ts:55

---

TControllerMethodCmdRouteArguments

Ƭ TControllerMethodCmdRouteArguments: Record<string | number, number>

Defined in

src/packages/iswork/src/types/controller.ts:96

---

TControllerMethodCmdRouteMetadata

Ƭ TControllerMethodCmdRouteMetadata: Object

Type declaration

Name	Type
arguments?	TControllerMethodCmdRouteOptions[]
cmd	string
description?	string
example?	string
name	string
options?	TControllerMethodCmdRouteOptions[]
shortDescription?	string
subcommand?	TControllerMethodCmdRouteMetadata
usage?	string

Defined in

src/packages/iswork/src/types/controller.ts:69

---

TControllerMethodCmdRouteOptions

Ƭ TControllerMethodCmdRouteOptions: Object

Type declaration

Name	Type
choices?	(string | number | boolean | null)[]
default?	any
description?	string
name	string
optional?	boolean
parameter	string[]
parameterType	string[]

Defined in

src/packages/iswork/src/types/controller.ts:81

---

TControllerMethodCmdRouteOptionsMetadata

Ƭ TControllerMethodCmdRouteOptionsMetadata: Record<string | number, Required<TControllerMethodCmdRouteOptions> | string[] | string>

Defined in

src/packages/iswork/src/types/controller.ts:91

---

TControllerMethodComponentAccept

Ƭ TControllerMethodComponentAccept<Props>: Record<string, unknown> | { component?: string ; extra?: Record<string, unknown> ; props?: Props }

Type parameters

Name	Type
Props	Record<string, unknown>

Defined in

src/packages/iswork/src/types/controller.ts:34

---

TControllerMethodComponentMetadata

Ƭ TControllerMethodComponentMetadata: Object

Type declaration

Name	Type
extra?	Record<string, unknown>
name	string
props?	Record<string, unknown>

Defined in

src/packages/iswork/src/types/controller.ts:17

---

TControllerMethodComponentOutput

Ƭ TControllerMethodComponentOutput<Props>: Object

Type parameters

Name	Type
Props	Record<string, unknown>

Type declaration

Name	Type
component	string
extra?	Record<string, unknown>
props	Props

Defined in

src/packages/iswork/src/types/controller.ts:38

---

TControllerMethodComponentResponse

Ƭ TControllerMethodComponentResponse<Props>: Object

Type parameters

Name	Type
Props	Record<string, unknown>

Type declaration

Name	Type
output	TControllerMethodComponentOutput<Props>[]

Defined in

src/packages/iswork/src/types/controller.ts:43

---

TControllerMethodMessageHandlerMetadata

Ƭ TControllerMethodMessageHandlerMetadata: Record<string | number, boolean>

Defined in

src/packages/iswork/src/types/controller.ts:27

---

TControllerMethodMessageMetadata

Ƭ TControllerMethodMessageMetadata: Object

Type declaration

Name	Type
message	boolean

Defined in

src/packages/iswork/src/types/controller.ts:23

---

TControllerMethodMetadata

Ƭ TControllerMethodMetadata: Object

Type declaration

Name	Type
alias?	string | string[]
version?	string

Defined in

src/packages/iswork/src/types/controller.ts:12

---

TControllerMethodParamFiledMetadata

Ƭ TControllerMethodParamFiledMetadata: TControllerMethodParamMetadata

Defined in

src/packages/iswork/src/types/controller.ts:49

---

TControllerMethodParamMetaMetadata

Ƭ TControllerMethodParamMetaMetadata: Record<string | number, string>

Defined in

src/packages/iswork/src/types/controller.ts:51

---

TControllerMethodParamMetadata

Ƭ TControllerMethodParamMetadata: Record<string | number, string>

Defined in

src/packages/iswork/src/types/controller.ts:47

---

TControllerMethodParamPayloadMetadata

Ƭ TControllerMethodParamPayloadMetadata: Record<string | number, boolean>

Defined in

src/packages/iswork/src/types/controller.ts:53

---

TControllerMethodReturnMetadata

Ƭ TControllerMethodReturnMetadata: Object

Type declaration

Name	Type
args?	unknown[]
name	string

Defined in

src/packages/iswork/src/types/controller.ts:29

---

TDataSourceAllOptions

Ƭ TDataSourceAllOptions: Object

Type declaration

Name	Type
fetch	TDataSourceFetchOptions
indexedDB	TDataSourceIndexedDBOptions
memoryDB	TDataSourceMemoryDBOptions

Defined in

src/packages/iswork/src/orm/types/data-source.ts:24

---

TDataSourceCommonOptions

Ƭ TDataSourceCommonOptions: Object

Type declaration

Name	Type
dbName?	string
entities	TModelType[]
name	string
type	TDataSourceType
version?	number | string

Defined in

src/packages/iswork/src/orm/types/data-source.ts:5

---

TDataSourceFetchOptions

Ƭ TDataSourceFetchOptions: TFetchWrapOptions & TDataSourceCommonOptions

Defined in

src/packages/iswork/src/orm/types/data-source.ts:18

---

TDataSourceIndexedDBOptions

Ƭ TDataSourceIndexedDBOptions: { dbName: string ; version: number } & TDataSourceCommonOptions

Defined in

src/packages/iswork/src/orm/types/data-source.ts:13

---

TDataSourceMemoryDBOptions

Ƭ TDataSourceMemoryDBOptions: { dbName: string } & TDataSourceCommonOptions

Defined in

src/packages/iswork/src/orm/types/data-source.ts:20

---

TDataSourceType

Ƭ TDataSourceType: "indexedDB" | "fetch" | "memoryDB"

Defined in

src/packages/iswork/src/orm/types/data-source.ts:3

---

TDecoratorAllColumnMetadata

Ƭ TDecoratorAllColumnMetadata: TDecoratorColumnMetadata & TDecoratorPrimaryColumnMetadata & TDecoratorIndexMetadata

Defined in

src/packages/iswork/src/orm/types/decorator.ts:24

---

TDecoratorCallbackCacheValue

Ƭ TDecoratorCallbackCacheValue: Object

Type declaration

Name	Type
decoratorType	EDecoratorType
fn	Function
key	string | symbol
type	EDecoratorCallbackType

Defined in

src/packages/iswork/src/types/decorator-register.ts:3

---

TDecoratorColumnMetadata

Ƭ TDecoratorColumnMetadata: TDecoratorColumnOptions

Defined in

src/packages/iswork/src/orm/types/decorator.ts:18

---

TDecoratorColumnOptions

Ƭ TDecoratorColumnOptions: Object

Type declaration

Name	Type
autoIncrement?	boolean
name?	string
primary?	boolean
type?	string
unique?	boolean

Defined in

src/packages/iswork/src/orm/types/decorator.ts:11

---

TDecoratorIndexMetadata

Ƭ TDecoratorIndexMetadata: TDecoratorIndexOptions

Defined in

src/packages/iswork/src/orm/types/decorator.ts:9

---

TDecoratorIndexOptions

Ƭ TDecoratorIndexOptions: Object

Type declaration

Name	Type
indexName?	string

Defined in

src/packages/iswork/src/orm/types/decorator.ts:6

---

TDecoratorModelMetadata

Ƭ TDecoratorModelMetadata: TDecoratorModelOptions

Defined in

src/packages/iswork/src/orm/types/decorator.ts:4

---

TDecoratorModelOptions

Ƭ TDecoratorModelOptions: Object

Type declaration

Name	Type
name?	string

Defined in

src/packages/iswork/src/orm/types/decorator.ts:1

---

TDecoratorPrimaryColumnMetadata

Ƭ TDecoratorPrimaryColumnMetadata: TDecoratorPrimaryColumnOptions

Defined in

src/packages/iswork/src/orm/types/decorator.ts:22

---

TDecoratorPrimaryColumnOptions

Ƭ TDecoratorPrimaryColumnOptions: TDecoratorColumnOptions

Defined in

src/packages/iswork/src/orm/types/decorator.ts:20

---

TDeprecatedCondOperator

Ƭ TDeprecatedCondOperator: "eq" | "ne" | "gt" | "lt" | "gte" | "lte" | "starts" | "ends" | "cont" | "excl" | "in" | "notin" | "isnull" | "notnull" | "between"

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:43

---

TDomainControllerMetadata

Ƭ TDomainControllerMetadata: Object

Type declaration

Name	Type
class	TScanClassMetadata
method	TScanPropertyMetadataMap

Defined in

src/packages/iswork/src/types/domain.ts:27

---

TDomainControllerMetadataMap

Ƭ TDomainControllerMetadataMap: Map<TController, TDomainControllerMetadata>

Defined in

src/packages/iswork/src/types/domain.ts:31

---

TDomainMetadata

Ƭ TDomainMetadata: Object

Type declaration

Name	Type
controllers?	TController[]
exports?	TMetadataExport[]
imports?	TMetadataImport[]
middlewares?	TMiddleware[]
name	string
providers?	TProviderMeta[]
viewName	string

Defined in

src/packages/iswork/src/types/domain.ts:11

---

TDomainOptions

Ƭ TDomainOptions: Object

Type declaration

Name	Type
isGlobal?	boolean
isRootDomain?	boolean
parentDomain?	Domain

Defined in

src/packages/iswork/src/types/domain.ts:21

---

TFetchSSEMessage

Ƭ TFetchSSEMessage: Object

Type declaration

Name	Type
data	string
event?	string
id	number
retry?	number

Defined in

src/packages/iswork/src/orm/types/driver.ts:1

---

TFetchWrapOptions

Ƭ TFetchWrapOptions: Object

Type declaration

Name	Type
prefixUrl?	string
requestOptions?	RequestInit

Defined in

src/packages/iswork/src/orm/types/driver.ts:8

---

TIdAnyObject

Ƭ TIdAnyObject<T>: { id: string | number } & Record<string | symbol, T>

Type parameters

Name	Type
T	unknown

Defined in

src/packages/iswork/src/orm/types/any-object.ts:8

---

TInjectionToken

Ƭ TInjectionToken<Type>: IAnyClass<Type> | string | symbol

令牌类型

Type parameters

Name	Type
Type	unknown

Defined in

src/packages/iswork/src/types/token.ts:4

---

TMessageIteratorData

Ƭ TMessageIteratorData: Record<string, any> & { meta?: { status?: EMessageStatus } }

Defined in

src/packages/iswork/src/message/message-iterator.ts:4

---

TMessageSSEIteratorData

Ƭ TMessageSSEIteratorData: Record<string, any>

Defined in

src/packages/iswork/src/message/message-sse.ts:4

---

TMessageSSEOptions

Ƭ TMessageSSEOptions: Object

Type declaration

Name	Type
prefixUrl?	string
sendHandler?	(message: any) => Promise<void>
sendUrl	string

Defined in

src/packages/iswork/src/message/message-sse.ts:5

---

TMetadataExport

Ƭ TMetadataExport: TProviderMeta | TController

Defined in

src/packages/iswork/src/types/domain.ts:9

---

TMetadataImport

Ƭ TMetadataImport: IDomainClass

Defined in

src/packages/iswork/src/types/domain.ts:8

---

TMiddleware

Ƭ TMiddleware<T>: (ctx: T, next: () => any) => any

Type parameters

Name	Type
T	any

Type declaration

▸ (ctx, next): any

Parameters

Name	Type
ctx	T
next	() => any

Returns

any

Defined in

src/packages/iswork/src/types/middleware.ts:1

---

TModelCreate

Ƭ TModelCreate<Model>: Omit<Model, TModelMethod> & TModelOnlyId

Type parameters

Name	Type
Model	extends BaseModel

Defined in

src/packages/iswork/src/orm/types/model.ts:15

---

TModelCreateNoId

Ƭ TModelCreateNoId<Model>: Omit<Model, "id" | TModelMethod>

Type parameters

Name	Type
Model	extends BaseModel

Defined in

src/packages/iswork/src/orm/types/model.ts:12

---

TModelData

Ƭ TModelData<Model>: Omit<Model, TModelMethod>

Type parameters

Name	Type
Model	extends BaseModel

Defined in

src/packages/iswork/src/orm/types/model.ts:21

---

TModelMethod

Ƭ TModelMethod: "save" | "toObject"

Defined in

src/packages/iswork/src/orm/types/model.ts:9

---

TModelOnlyId

Ƭ TModelOnlyId: Object

Type declaration

Name	Type
id	string | number

Defined in

src/packages/iswork/src/orm/types/model.ts:3

---

TModelPartialData

Ƭ TModelPartialData<Model>: Partial<Omit<Model, TModelMethod>>

Type parameters

Name	Type
Model	extends BaseModel

Defined in

src/packages/iswork/src/orm/types/model.ts:27

---

TModelRequireData

Ƭ TModelRequireData<Model>: Required<Omit<Model, TModelMethod>>

Type parameters

Name	Type
Model	extends BaseModel

Defined in

src/packages/iswork/src/orm/types/model.ts:24

---

TModelType

Ƭ TModelType: typeof BaseModel

Defined in

src/packages/iswork/src/orm/types/model.ts:7

---

TModelUpdate

Ƭ TModelUpdate<Model>: Partial<Omit<Model, TModelMethod>> & TModelOnlyId

Type parameters

Name	Type
Model	extends BaseModel

Defined in

src/packages/iswork/src/orm/types/model.ts:18

---

TOrmQuery

Ƭ TOrmQuery: string | IQueryParamsOptions | QueryBuilder

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:7

---

TParamOptionType

Ƭ TParamOptionType: "number" | "string" | "uuid"

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:4

---

TProvider

Ƭ TProvider<Class>: IClassProvider<Class> | IValueProvider<Class> | IFactoryProvider<Class>

Type parameters

Name	Type
Class	unknown

Defined in

src/packages/iswork/src/types/provider.ts:5

---

TProviderClass

Ƭ TProviderClass<Class>: IAnyClass<Class>

Type parameters

Name	Type
Class	unknown

Defined in

src/packages/iswork/src/types/provider.ts:3

---

TProviderMeta

Ƭ TProviderMeta<Class>: TProvider<Class> | TProviderClass<Class>

Type parameters

Name	Type
Class	unknown

Defined in

src/packages/iswork/src/types/provider.ts:7

---

TQueryBuilderOptions

Ƭ TQueryBuilderOptions: Required<IPartialQueryBuilderOptions> & { paramNamesMap: Required<IPartialQueryBuilderOptions["paramNamesMap"]> }

Defined in

src/packages/iswork/src/orm/query-builder.ts:27

---

TQueryBuilderOptionsKeys

Ƭ TQueryBuilderOptionsKeys: keyof IQueryParamsOptions

Defined in

src/packages/iswork/src/orm/query-builder.ts:32

---

TQueryFields

Ƭ TQueryFields: string[]

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:10

---

TQueryFilter

Ƭ TQueryFilter: Object

Type declaration

Name	Type
field	string
operator	TComparisonOperator
value?	any

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:93

---

TQueryFilterArr

Ƭ TQueryFilterArr: [string, TComparisonOperator, any?]

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:100

---

TQueryJoin

Ƭ TQueryJoin: Object

Type declaration

Name	Type
field	string
select?	TQueryFields

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:28

---

TQueryJoinArr

Ƭ TQueryJoinArr: [string, TQueryFields?]

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:34

---

TQuerySort

Ƭ TQuerySort: Object

Type declaration

Name	Type
field	string
order	TQuerySortOperator

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:16

---

TQuerySortArr

Ƭ TQuerySortArr: [string, TQuerySortOperator]

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:22

---

TQuerySortOperator

Ƭ TQuerySortOperator: "ASC" | "DESC"

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:13

---

TSCondition

Ƭ TSCondition: TSFields | TSConditionAND

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:119

---

TSConditionAND

Ƭ TSConditionAND: Object

Type declaration

Name	Type
$and?	(TSFields | TSConditionAND)[]
$or?	never

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:113

---

TSConditionKey

Ƭ TSConditionKey: "$and" | "$or"

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:25

---

TSField

Ƭ TSField: TSPrimitivesVal | TSFieldOperator

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:103

---

TSFieldOperator

Ƭ TSFieldOperator: Object

Type declaration

Name	Type
$and?	never
$between?	TSFiledValues
$cont?	TSFiledValues
$contL?	TSFiledValues
$ends?	TSFiledValues
$endsL?	TSFiledValues
$eq?	TSFiledValues
$eqL?	TSFiledValues
$excl?	TSFiledValues
$exclL?	TSFiledValues
$gt?	TSFiledValues
$gte?	TSFiledValues
$in?	TSFiledValues
$inL?	TSFiledValues
$isnull?	TSFiledValues
$lt?	TSFiledValues
$lte?	TSFiledValues
$ne?	TSFiledValues
$neL?	TSFiledValues
$notin?	TSFiledValues
$notinL?	TSFiledValues
$notnull?	TSFiledValues
$or?	TSFieldOperator
$starts?	TSFiledValues
$startsL?	TSFiledValues

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:61

---

TSFields

Ƭ TSFields: Object

Index signature

▪ [key: string]: TSField | (TSFields | TSConditionAND)[] | undefined

Type declaration

Name	Type
$and?	never
$or?	(TSFields | TSConditionAND)[]

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:106

---

TSFiledValues

Ƭ TSFiledValues: TSPrimitivesVal | TSPrimitivesVal[]

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:40

---

TSPrimitivesVal

Ƭ TSPrimitivesVal: string | number | boolean

Defined in

src/packages/iswork/src/orm/types/query-builder.ts:37

---

TScanClassMetadata

Ƭ TScanClassMetadata<Value>: Map<string | symbol, Value>

Type parameters

Name	Type
Value	unknown

Defined in

src/packages/iswork/src/types/metadata-scanner.ts:1

---

TScanPropertyMetadata

Ƭ TScanPropertyMetadata<Value>: [string | symbol, string | symbol, Value][]

Type parameters

Name	Type
Value	unknown

Defined in

src/packages/iswork/src/types/metadata-scanner.ts:2

---

TScanPropertyMetadataMap

Ƭ TScanPropertyMetadataMap<Value>: Map<string | symbol, TScanPropertyMetadataMapValue<Value>>

Type parameters

Name	Type
Value	unknown

Defined in

src/packages/iswork/src/types/metadata-scanner.ts:7

---

TScanPropertyMetadataMapValue

Ƭ TScanPropertyMetadataMapValue<Value>: Object

Type parameters

Name	Type
Value	unknown

Type declaration

Name	Type
info	Record<string | symbol, Value>
list	[string | symbol, Value][]

Defined in

src/packages/iswork/src/types/metadata-scanner.ts:3

---

TSubscribeCallback

Ƭ TSubscribeCallback<V>: (observer: IObserver<V>) => TUnSubscribe

Type parameters

Name	Type
V	unknown

Type declaration

▸ (observer): TUnSubscribe

Parameters

Name	Type
observer	IObserver<V>

Returns

TUnSubscribe

Defined in

src/packages/iswork/src/message/message-observable.ts:7

---

TUnSubscribe

Ƭ TUnSubscribe: Object

Type declaration

Name	Type
unsubscribe	() => void

Defined in

src/packages/iswork/src/message/message-observable.ts:8

Variables

CONTROLLER_METADATA

• Const CONTROLLER_METADATA: typeof CONTROLLER_METADATA

Defined in

src/packages/iswork/src/constants/decorator.ts:5

---

CONTROLLER_METHOD_CMDROUTE_METADATA

• Const CONTROLLER_METHOD_CMDROUTE_METADATA: typeof CONTROLLER_METHOD_CMDROUTE_METADATA

Defined in

src/packages/iswork/src/constants/decorator.ts:19

---

CONTROLLER_METHOD_COMPONENT_METADATA

• Const CONTROLLER_METHOD_COMPONENT_METADATA: typeof CONTROLLER_METHOD_COMPONENT_METADATA

Defined in

src/packages/iswork/src/constants/decorator.ts:9

---

CONTROLLER_METHOD_MESSAGE_HANDLER_METADATA

• Const CONTROLLER_METHOD_MESSAGE_HANDLER_METADATA: typeof CONTROLLER_METHOD_MESSAGE_HANDLER_METADATA

Defined in

src/packages/iswork/src/constants/decorator.ts:17

---

CONTROLLER_METHOD_MESSAGE_METADATA

• Const CONTROLLER_METHOD_MESSAGE_METADATA: typeof CONTROLLER_METHOD_MESSAGE_METADATA

Defined in

src/packages/iswork/src/constants/decorator.ts:15

---

CONTROLLER_METHOD_METADATA

• Const CONTROLLER_METHOD_METADATA: typeof CONTROLLER_METHOD_METADATA

Defined in

src/packages/iswork/src/constants/decorator.ts:7

---

CONTROLLER_METHOD_NAME_METADATA

• Const CONTROLLER_METHOD_NAME_METADATA: typeof CONTROLLER_METHOD_NAME_METADATA

Defined in

src/packages/iswork/src/constants/decorator.ts:13

---

CONTROLLER_METHOD_PARAM_CMDROUTEARGUMENTS_METADATA

• Const CONTROLLER_METHOD_PARAM_CMDROUTEARGUMENTS_METADATA: typeof CONTROLLER_METHOD_PARAM_CMDROUTEARGUMENTS_METADATA

Defined in

src/packages/iswork/src/constants/decorator.ts:29

---

CONTROLLER_METHOD_PARAM_CMDROUTEOPTIONS_METADATA

• Const CONTROLLER_METHOD_PARAM_CMDROUTEOPTIONS_METADATA: typeof CONTROLLER_METHOD_PARAM_CMDROUTEOPTIONS_METADATA

Defined in

src/packages/iswork/src/constants/decorator.ts:27

---

CONTROLLER_METHOD_PARAM_FILED_METADATA

• Const CONTROLLER_METHOD_PARAM_FILED_METADATA: typeof CONTROLLER_METHOD_PARAM_FILED_METADATA

Defined in

src/packages/iswork/src/constants/decorator.ts:21

---

CONTROLLER_METHOD_PARAM_META_METADATA

• Const CONTROLLER_METHOD_PARAM_META_METADATA: typeof CONTROLLER_METHOD_PARAM_META_METADATA

Defined in

src/packages/iswork/src/constants/decorator.ts:23

---

CONTROLLER_METHOD_PARAM_PAYLOAD_METADATA

• Const CONTROLLER_METHOD_PARAM_PAYLOAD_METADATA: typeof CONTROLLER_METHOD_PARAM_PAYLOAD_METADATA

Defined in

src/packages/iswork/src/constants/decorator.ts:25

---

CONTROLLER_METHOD_RETURN_METADATA

• Const CONTROLLER_METHOD_RETURN_METADATA: typeof CONTROLLER_METHOD_RETURN_METADATA

Defined in

src/packages/iswork/src/constants/decorator.ts:11

---

DESIGN_PARAMTYPES

• Const DESIGN_PARAMTYPES: "design:paramtypes"

Defined in

src/packages/iswork/src/constants/decorator.ts:35

---

DOMAIN_METADATA

• Const DOMAIN_METADATA: typeof DOMAIN_METADATA

Defined in

src/packages/iswork/src/constants/decorator.ts:3

---

Decorator

• Const Decorator: Object

Type declaration

Name	Type
ControllerCmdRouteArgumentsDecorator	typeof ControllerCmdRouteArgumentsDecorator
ControllerCmdRouteDecorator	typeof ControllerCmdRouteDecorator
ControllerCmdRouteOptionsDecorator	typeof ControllerCmdRouteOptionsDecorator
ControllerComponentDecorator	typeof ControllerComponentDecorator
ControllerDecorator	typeof ControllerDecorator
ControllerFieldDecorator	typeof ControllerFieldDecorator
ControllerMetaDecorator	typeof ControllerMetaDecorator
ControllerMethodDecorator	typeof ControllerMethodDecorator
ControllerMethodReturnDecorator	typeof ControllerMethodReturnDecorator
ControllerPayloadDecorator	typeof ControllerPayloadDecorator
DomainDecorator	typeof DomainDecorator
GlobalDomainDecorator	typeof GlobalDomainDecorator

Defined in

src/packages/iswork/src/decorators/index.ts:21

---

GLOBAL_DOMAIN_METADATA

• Const GLOBAL_DOMAIN_METADATA: typeof GLOBAL_DOMAIN_METADATA

Defined in

src/packages/iswork/src/constants/decorator.ts:1

---

GLOBAL_SCOPE

• Const GLOBAL_SCOPE: typeof GLOBAL_SCOPE

Defined in

src/packages/iswork/src/constants/ioc-container.ts:1

---

IOC_INJECT

• Const IOC_INJECT: typeof IOC_INJECT

Defined in

src/packages/iswork/src/constants/decorator.ts:31

---

IOC_INJECTABLE

• Const IOC_INJECTABLE: typeof IOC_INJECTABLE

Defined in

src/packages/iswork/src/constants/decorator.ts:33

---

comparisonOperatorsList

• Const comparisonOperatorsList: string[]

Defined in

src/packages/iswork/src/orm/query-builder.ts:77

---

decoratorRegister

• Const decoratorRegister: DecoratorRegister

Defined in

src/packages/iswork/src/decorators/index.ts:47

---

deprecatedComparisonOperatorsList

• Const deprecatedComparisonOperatorsList: string[]

eq (=, equal) ne (!=, not equal) gt (>, greater than) lt (<, lower that) gte (>=, greater than or equal) lte (<=, lower than or equal) starts (LIKE val%, starts with) ends (LIKE %val, ends with) cont (LIKE %val%, contains) excl (NOT LIKE %val%, not contains) in (IN, in range, accepts multiple values) notin (NOT IN, not in range, accepts multiple values) isnull (IS NULL, is NULL, doesn't accept value) notnull (IS NOT NULL, not NULL, doesn't accept value) between (BETWEEN, between, accepts two values) eqL (LOWER(field) =, equal) neL (LOWER(field) !=, not equal) startsL (LIKE|ILIKE val%) endsL (LIKE|ILIKE %val, ends with) contL (LIKE|ILIKE %val%, contains) exclL (NOT LIKE|ILIKE %val%, not contains) inL (LOWER(field) IN, in range, accepts multiple values) notinL (LOWER(field) NOT IN, not in range, accepts multiple values)

Defined in

src/packages/iswork/src/orm/query-builder.ts:60

---

sortOrdersList

• Const sortOrdersList: string[]

Defined in

src/packages/iswork/src/orm/query-builder.ts:34

Functions

CmdRoute

▸ CmdRoute(options): (target: object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<any>) => TypedPropertyDescriptor<any>

Parameters

Name	Type
options	TControllerMethodCmdRoute

Returns

fn

▸ (target, propertyKey, descriptor): TypedPropertyDescriptor<any>

Parameters

Name	Type
target	object
propertyKey	string | symbol
descriptor	TypedPropertyDescriptor<any>

Returns

TypedPropertyDescriptor<any>

Defined in

src/packages/iswork/src/decorators/index.ts:51

---

CmdRouteArguments

▸ CmdRouteArguments(index?): (target: object, propertyKey: undefined | string | symbol, parameterIndex: number) => void

Parameters

Name	Type
index?	number

Returns

fn

▸ (target, propertyKey, parameterIndex): void

Parameters

Name	Type
target	object
propertyKey	undefined | string | symbol
parameterIndex	number

Returns

void

Defined in

src/packages/iswork/src/decorators/index.ts:59

---

CmdRouteOptions

▸ CmdRouteOptions(paramKey): ParameterDecorator

Parameters

Name	Type
paramKey	string

Returns

ParameterDecorator

Defined in

src/packages/iswork/src/decorators/index.ts:55

▸ CmdRouteOptions(paramKey): ParameterDecorator

Parameters

Name	Type
paramKey	string[]

Returns

ParameterDecorator

Defined in

src/packages/iswork/src/decorators/index.ts:55

▸ CmdRouteOptions(options): ParameterDecorator

Parameters

Name	Type
options	TControllerMethodCmdRouteOptions

Returns

ParameterDecorator

Defined in

src/packages/iswork/src/decorators/index.ts:55

---

Column

▸ Column(options?): PropertyDecorator

定义属性列

Parameters

Name	Type
options?	TDecoratorColumnOptions

Returns

PropertyDecorator

Defined in

src/packages/iswork/src/orm/decorators/columns/Column.ts:11

▸ Column(type, options?): PropertyDecorator

Parameters

Name	Type
type	string
options?	TDecoratorColumnOptions

Returns

PropertyDecorator

Defined in

src/packages/iswork/src/orm/decorators/columns/Column.ts:13

---

Component

▸ Component(name?): MethodDecorator

Parameters

Name	Type
name?	string

Returns

MethodDecorator

Defined in

src/packages/iswork/src/decorators/index.ts:66

▸ Component(options): MethodDecorator

Parameters

Name	Type
options	TControllerMethodComponentMetadata | TControllerMethodComponentMetadata[]

Returns

MethodDecorator

Defined in

src/packages/iswork/src/decorators/index.ts:66

---

Controller

▸ Controller(): ClassDecorator

Returns

ClassDecorator

Defined in

src/packages/iswork/src/decorators/index.ts:50

▸ Controller(alias): ClassDecorator

Parameters

Name	Type
alias	string | string[]

Returns

ClassDecorator

Defined in

src/packages/iswork/src/decorators/index.ts:50

▸ Controller(options): ClassDecorator

Parameters

Name	Type
options	TControllerMetadata

Returns

ClassDecorator

Defined in

src/packages/iswork/src/decorators/index.ts:50

---

Domain

▸ Domain(metadata): (target: Function) => void

Parameters

Name	Type
metadata	TDomainMetadata

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/packages/iswork/src/decorators/index.ts:49

---

Field

▸ Field(field): (target: object, propertyKey: undefined | string | symbol, parameterIndex: number) => void

Parameters

Name	Type
field	string

Returns

fn

▸ (target, propertyKey, parameterIndex): void

Parameters

Name	Type
target	object
propertyKey	undefined | string | symbol
parameterIndex	number

Returns

void

Defined in

src/packages/iswork/src/decorators/index.ts:63

---

Global

▸ Global(): (target: Function) => void

Returns

fn

▸ (target): void

Parameters

Name	Type
target	Function

Returns

void

Defined in

src/packages/iswork/src/decorators/index.ts:48

---

Index

▸ Index(options?): PropertyDecorator

Parameters

Name	Type
options?	TDecoratorIndexOptions

Returns

PropertyDecorator

Defined in

src/packages/iswork/src/orm/decorators/columns/Index.ts:6

▸ Index(name, options?): PropertyDecorator

Parameters

Name	Type
name	string
options?	TDecoratorIndexOptions

Returns

PropertyDecorator

Defined in

src/packages/iswork/src/orm/decorators/columns/Index.ts:8

---

Inject

▸ Inject(token): (target: IAnyClass<any>, propertyKey: string | symbol, index: number) => IAnyClass<any>

注入装饰器

Parameters

Name	Type
token	TInjectionToken

Returns

fn

▸ (target, propertyKey, index): IAnyClass<any>

Parameters

Name	Type
target	IAnyClass<any>
propertyKey	string | symbol
index	number

Returns

IAnyClass<any>

Defined in

src/packages/iswork/src/ioc/decorators/inject.ts:10

---

Injectable

▸ Injectable(): (target: IAnyClass<any>) => IAnyClass<any>

定义类能注入装饰器

Returns

fn

▸ (target): IAnyClass<any>

Parameters

Name	Type
target	IAnyClass<any>

Returns

IAnyClass<any>

Defined in

src/packages/iswork/src/ioc/decorators/injectable.ts:8

---

Message

▸ Message(options?): MethodDecorator

Parameters

Name	Type
options	TControllerMethodMessageMetadata

Returns

MethodDecorator

Defined in

src/packages/iswork/src/decorators/index.ts:79

---

MessageHandler

▸ MessageHandler(): (target: object, propertyKey: undefined | string | symbol, parameterIndex: number) => void

Returns

fn

▸ (target, propertyKey, parameterIndex): void

Parameters

Name	Type
target	object
propertyKey	undefined | string | symbol
parameterIndex	number

Returns

void

Defined in

src/packages/iswork/src/decorators/index.ts:84

---

Meta

▸ Meta(field): (target: object, propertyKey: undefined | string | symbol, parameterIndex: number) => void

Parameters

Name	Type
field	string

Returns

fn

▸ (target, propertyKey, parameterIndex): void

Parameters

Name	Type
target	object
propertyKey	undefined | string | symbol
parameterIndex	number

Returns

void

Defined in

src/packages/iswork/src/decorators/index.ts:64

---

Method

▸ Method(alias): MethodDecorator

Parameters

Name	Type
alias	string | string[]

Returns

MethodDecorator

Defined in

src/packages/iswork/src/decorators/index.ts:65

▸ Method(options): MethodDecorator

Parameters

Name	Type
options	TControllerMethodMetadata

Returns

MethodDecorator

Defined in

src/packages/iswork/src/decorators/index.ts:65

---

Model

▸ Model(options?): ClassDecorator

定义模型

Parameters

Name	Type
options?	TDecoratorModelOptions

Returns

ClassDecorator

Defined in

src/packages/iswork/src/orm/decorators/model/Model.ts:11

▸ Model(name?, options?): ClassDecorator

Parameters

Name	Type
name?	string
options?	TDecoratorModelOptions

Returns

ClassDecorator

Defined in

src/packages/iswork/src/orm/decorators/model/Model.ts:12

---

Payload

▸ Payload(): (target: object, propertyKey: undefined | string | symbol, parameterIndex: number) => void

Returns

fn

▸ (target, propertyKey, parameterIndex): void

Parameters

Name	Type
target	object
propertyKey	undefined | string | symbol
parameterIndex	number

Returns

void

Defined in

src/packages/iswork/src/decorators/index.ts:74

---

PrimaryColumn

▸ PrimaryColumn(options?): PropertyDecorator

定义主键属性列

Parameters

Name	Type
options?	TDecoratorColumnOptions

Returns

PropertyDecorator

Defined in

src/packages/iswork/src/orm/decorators/columns/PrimaryColumn.ts:11

▸ PrimaryColumn(type, options?): PropertyDecorator

Parameters

Name	Type
type	string
options?	TDecoratorColumnOptions

Returns

PropertyDecorator

Defined in

src/packages/iswork/src/orm/decorators/columns/PrimaryColumn.ts:12

---

Return

▸ Return(pipeName): MethodDecorator

Parameters

Name	Type
pipeName	string

Returns

MethodDecorator

Defined in

src/packages/iswork/src/decorators/index.ts:70

▸ Return(options): MethodDecorator

Parameters

Name	Type
options	TControllerMethodReturnMetadata | TControllerMethodReturnMetadata[]

Returns

MethodDecorator

Defined in

src/packages/iswork/src/decorators/index.ts:70

---

getColumnMetadata

▸ getColumnMetadata(target): undefined | TDecoratorColumnOptions

Parameters

Name	Type
target	IAnyClass<unknown>

Returns

undefined | TDecoratorColumnOptions

Defined in

src/packages/iswork/src/orm/decorators/columns/Column.ts:28

---

getIndexMetadata

▸ getIndexMetadata(target): undefined | TDecoratorIndexOptions

Parameters

Name	Type
target	IAnyClass<unknown>

Returns

undefined | TDecoratorIndexOptions

Defined in

src/packages/iswork/src/orm/decorators/columns/Index.ts:21

---

getInjectMetadata

▸ getInjectMetadata(target, propertyKey): undefined | (undefined | TInjectionToken)[]

Parameters

Name	Type
target	IAnyClass<unknown>
propertyKey	string

Returns

undefined | (undefined | TInjectionToken)[]

Defined in

src/packages/iswork/src/ioc/decorators/inject.ts:20

---

getInjectableMetadata

▸ getInjectableMetadata(target): undefined | boolean

Parameters

Name	Type
target	IAnyClass<unknown>

Returns

undefined | boolean

Defined in

src/packages/iswork/src/ioc/decorators/injectable.ts:15

---

getModelMetadata

▸ getModelMetadata(target): undefined | TDecoratorModelOptions

Parameters

Name	Type
target	IAnyClass<unknown>

Returns

undefined | TDecoratorModelOptions

Defined in

src/packages/iswork/src/orm/decorators/model/Model.ts:24

---

getPrimaryColumnMetadata

▸ getPrimaryColumnMetadata(target): undefined | TDecoratorColumnOptions

Parameters

Name	Type
target	IAnyClass<unknown>

Returns

undefined | TDecoratorColumnOptions

Defined in

src/packages/iswork/src/orm/decorators/columns/PrimaryColumn.ts:32

---

registerAndWrapHandler

▸ registerAndWrapHandler<Decorator>(decoratorRegister, decorator): Decorator["handler"]

内部装饰注册

Type parameters

Name	Type
Decorator	extends AbstractDecorator

Parameters

Name	Type
decoratorRegister	DecoratorRegister
decorator	(key?: string | symbol) => Decorator

Returns

Decorator["handler"]

Defined in

src/packages/iswork/src/decorators/index.ts:40