Class RegistryAccess

Index

Constructors

Methods

findType getAliasTypes getFolderContentTypes getParentType getRegistry getStrictFolderTypes getTypeByName getTypeBySuffix guessTypeBySuffix

Constructors

constructor

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

Methods

findType

findType(predicate): undefined | MetadataType
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
  - - (type): boolean
    - Parameters
      type: MetadataType
      Returns boolean
Returns undefined | MetadataType
The first metadata type object that fulfills the predicate
- Defined in registry/registryAccess.ts:104

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:150

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:133

getParentType

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

getRegistry

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

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:116

getTypeByName

getTypeByName(name): 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:39

getTypeBySuffix

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

guessTypeBySuffix

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