Class RegistryAccess

Index

Constructors

Methods

findType getAliasTypes getFolderContentTypes getParentType getRegistry getStrictFolderTypes getTypeByName getTypeBySuffix guessTypeBySuffix

Constructors

constructor

new RegistryAccess(
registry?: MetadataRegistry,
projectDir?: string,
): RegistryAccess
Parameters
- Optionalregistry: MetadataRegistry
- OptionalprojectDir: string
Returns RegistryAccess
- Defined in registry/registryAccess.ts:35

Methods

findType

findType(predicate: (type: MetadataType) => boolean): MetadataType | undefined
Searches for the first metadata type in the registry that returns true for the given predicate function.

Can return undefined if no type matches the predicate.
Parameters
- predicate: (type: MetadataType) => boolean
  Predicate to test types with
Returns MetadataType | undefined
The first metadata type object that fulfills the predicate
- Defined in registry/registryAccess.ts:114

getAliasTypes

getAliasTypes(): MetadataType[]
Query for the types that have the aliasFor property defined. E.g., EmailTemplateFolder

Returns MetadataType[]
An array of metadata type objects that have aliasFor

See
MetadataType.aliasFor
- Defined in registry/registryAccess.ts:160

getFolderContentTypes

getFolderContentTypes(): MetadataType[]
Query for the types that have the folderContentType property defined. E.g., reportFolder, dashboardFolder, documentFolder, emailFolder

Returns MetadataType[]
An array of metadata type objects that have folder content

See
MetadataType.folderContentType
- Defined in registry/registryAccess.ts:143

getParentType

getParentType(childName: string): MetadataType | undefined
Return the parent metadata type from the registry for the given child type
Parameters
- childName: string
  Child metadata type name
Returns MetadataType | undefined
Parent metadata type object or undefined if no parent exists
- Defined in registry/registryAccess.ts:173

getRegistry

getRegistry(): MetadataRegistry
Returns MetadataRegistry
- Defined in registry/registryAccess.ts:39

getStrictFolderTypes

getStrictFolderTypes(): MetadataType[]
Query the types that require a strict parent directory

Returns MetadataType[]
An array of metadata type objects that require strict parent folder names

See
MetadataType.strictDirectoryName
- Defined in registry/registryAccess.ts:126

getTypeByName

getTypeByName(name: string): MetadataType
Query a metadata type by its name.
Parameters
- name: string
  Case-insensitive name of the metadata type
Returns MetadataType
The corresponding metadata type object
- Defined in registry/registryAccess.ts:49

getTypeBySuffix

getTypeBySuffix(suffix: string): MetadataType | undefined
Query a metadata type by its file suffix.
Parameters
- suffix: string
  File suffix of the metadata type
Returns MetadataType | undefined
The corresponding metadata type object
- Defined in registry/registryAccess.ts:80

guessTypeBySuffix

guessTypeBySuffix(
suffix: string,
): { metadataTypeGuess: MetadataType; suffixGuess: string }[] | undefined
Find similar metadata type matches by its file suffix
Parameters
- suffix: string
  File suffix of the metadata type
Returns { metadataTypeGuess: MetadataType; suffixGuess: string }[] | undefined
An array of similar suffix and metadata type matches
- Defined in registry/registryAccess.ts:93