index

@agros/tools

@agros/tools

Table of contents

Classes

• ComponentInstance
• ModuleInstance

Interfaces

• AddImportedEntityToModuleOptions
• AddImportedServiceToServiceOptions
• AddRouteToModuleOptions
• BootstrapConfigItem
• BundlessPlatform
• CodeLocation
• CollectionDescriptor
• ComponentDecoratorOptions
• ComponentInstanceMetadata
• ComponentScript
• Container
• ContainerForwardedComponentProps
• DynamicModule
• EnsureImportOptions
• EnsureImportResult
• EntityDescriptor
• EntryTailCodeData
• Factory
• FactoryCode
• FactoryProvider
• GetComponentFactoryCodeData
• Interceptor
• ModuleDecoratorOptions
• ModuleInstanceMetadata
• ModuleMetadata
• PathDescriptor
• Platform
• PlatformConfig
• PlatformFiles
• RootContainerProps
• RootPointDescriptor
• RouteOptionItem
• RouteProps
• RouterItem
• UpdateItem
• ValueProvider

Type Aliases

• AddVirtualFile
• AsyncModuleClass
• BaseProvider
• BaseProviderWithValue
• CollectionMap
• CollectionType
• ComponentMetadata
• EnsureImportType
• Provider
• ProviderToken
• ProviderWithValue
• Type
• Updater
• UpdaterWithChecker
• UseInterceptorsDecoratorOptions

Variables

• HOST_MODULE
• PROVIDER_MODULE

Functions

• isBasicProvider
• isClass
• isDynamicModule
• isFactoryProvider
• isParameterDep
• isValueProvider

Type Aliases

AddVirtualFile

Ƭ AddVirtualFile: (pathname: string, content: string) => string

Type declaration

▸ (pathname, content): string

Parameters

Name	Type
pathname	string
content	string

Returns

string

Defined in

packages/agros-tools/src/platform.interface.ts:4

---

AsyncModuleClass

Ƭ AsyncModuleClass<T>: Type<T> | Promise<Type<T>> | DynamicModule<T>

Type parameters

Name	Type
T	any

Defined in

packages/agros-tools/src/types.ts:59

---

BaseProvider

Ƭ BaseProvider: ValueProvider | FactoryProvider

Defined in

packages/agros-tools/src/types.ts:61

---

BaseProviderWithValue

Ƭ BaseProviderWithValue<T>: BaseProvider & { value: T }

Type parameters

Name	Type
T	any

Defined in

packages/agros-tools/src/types.ts:64

---

CollectionMap

Ƭ CollectionMap: Record<string, string[]>

Defined in

packages/agros-tools/src/types.ts:11

---

CollectionType

Ƭ CollectionType: "module" | "service" | "component" | "interceptor"

Defined in

packages/agros-tools/src/types.ts:12

---

ComponentMetadata

Ƭ ComponentMetadata: Omit<ComponentDecoratorOptions, "declarations"> & { factory?: () => any ; uuid: string }

Defined in

packages/agros-tools/src/types.ts:38

---

EnsureImportType

Ƭ EnsureImportType: "named" | "default" | "namespace"

Defined in

packages/agros-tools/src/types.ts:171

---

Provider

Ƭ Provider<T>: Type<T> | BaseProvider

Type parameters

Name	Type
T	any

Defined in

packages/agros-tools/src/types.ts:62

---

ProviderToken

Ƭ ProviderToken: string | symbol

Defined in

packages/agros-tools/src/types.ts:70

---

ProviderWithValue

Ƭ ProviderWithValue<T, V>: Type<T> | BaseProviderWithValue<V>

Type parameters

Name	Type
T	any
V	any

Defined in

packages/agros-tools/src/types.ts:68

---

Type

Ƭ Type<T>: (...args: any[]) => T

Type parameters

Name	Type
T	any

Type declaration

• (...args)

Parameters

Name	Type
...args	any[]

Defined in

packages/agros-tools/src/types.ts:58

---

Updater

Ƭ Updater<T>: (data: { classImportItem: ClassImportItem<t.ClassDeclaration> ; initialResult: UpdateItem[] ; options?: T ; sourceDescriptor: EntityDescriptor ; targetAST: ParseResult<t.File> ; targetDescriptor: EntityDescriptor }) => Promise<UpdateItem[]>

Type parameters

Name
T

Type declaration

▸ (data): Promise<UpdateItem[]>

Parameters

Name	Type
data	Object
data.classImportItem	ClassImportItem<t.ClassDeclaration>
data.initialResult	UpdateItem[]
data.options?	T
data.sourceDescriptor	EntityDescriptor
data.targetAST	ParseResult<t.File>
data.targetDescriptor	EntityDescriptor

Returns

Promise<UpdateItem[]>

Defined in

packages/agros-tools/src/types.ts:230

---

UpdaterWithChecker

Ƭ UpdaterWithChecker<T>: (sourceDescriptor: EntityDescriptor, targetDescriptor: EntityDescriptor, options?: T) => Promise<UpdateItem[]>

Type parameters

Name	Type
T	any

Type declaration

▸ (sourceDescriptor, targetDescriptor, options?): Promise<UpdateItem[]>

Parameters

Name	Type
sourceDescriptor	EntityDescriptor
targetDescriptor	EntityDescriptor
options?	T

Returns

Promise<UpdateItem[]>

Defined in

packages/agros-tools/src/types.ts:239

---

UseInterceptorsDecoratorOptions

Ƭ UseInterceptorsDecoratorOptions: Type[]

Defined in

packages/agros-tools/src/types.ts:157

Variables

HOST_MODULE

• Const HOST_MODULE: "HOST_MODULE"

Defined in

packages/agros-tools/src/constants.ts:2

---

PROVIDER_MODULE

• Const PROVIDER_MODULE: "PROVIDER_MODULE"

Defined in

packages/agros-tools/src/constants.ts:1

Functions

isBasicProvider

▸ isBasicProvider(object): boolean

Parameters

Name	Type
object	any

Returns

boolean

Defined in

packages/agros-tools/src/is.ts:14

---

isClass

▸ isClass(obj): boolean

Parameters

Name	Type
obj	any

Returns

boolean

Defined in

packages/agros-tools/src/is.ts:1

---

isDynamicModule

▸ isDynamicModule(object): boolean

Parameters

Name	Type
object	any

Returns

boolean

Defined in

packages/agros-tools/src/is.ts:10

---

isFactoryProvider

▸ isFactoryProvider(object): boolean

Parameters

Name	Type
object	any

Returns

boolean

Defined in

packages/agros-tools/src/is.ts:20

---

isParameterDep

▸ isParameterDep(object): boolean

Parameters

Name	Type
object	any

Returns

boolean

Defined in

packages/agros-tools/src/is.ts:24

---

isValueProvider

▸ isValueProvider(object): boolean

Parameters

Name	Type
object	any

Returns

boolean

Defined in

packages/agros-tools/src/is.ts:16