Partager via


Templates class

Entrée LG, y compris les propriétés dont le fichier LG a, et évaluer les fonctions.

Constructeurs

Templates(Template[], TemplateImport[], Diagnostic[], Templates[], string, string, ExpressionParser, ImportResolverDelegate, string[], string, Record<string, Templates>)

Crée une instance de la classe templates .

Propriétés

allDiagnostics

Obtient tous les diagnostics du fichier lg actuel et des fichiers lg de référence.

allTemplates

Obtient tous les modèles du fichier lg actuel et des fichiers lg de référence.

content

Contenu LG.

diagnostics

diagnostic.

enableFromFile

Indique si fromFile est autorisé dans les modèles LG.

expressionParser

analyseur d’expression.

id

ID de la ressource lg.

importResolver

Délégué pour la résolution de l’ID de ressource du fichier lg importé.

imports

importez des éléments que ce fichier LG contient directement.

inlineTemplateIdPrefix

ID de modèle temporaire pour le contenu inline.

lgOptions

Obtient les options d’evluation pour le fichier LG actuel. @returns valeur A indiquant si les options lors de l’évaluation des modèles LG.

namedReferences

Mappez de l’alias d’importation aux modèles.

namespace

Obtient l’espace de noms à inscrire pour le fichier LG actuel. @returns Valeur de chaîne représentant l’espace de noms à inscrire au fichier LG actuel.

options

Options de fichier LG.

references

toutes les références que ce fichier LG a de Imports otice : référence inclut toutes les importations enfants à partir du fichier lg, pas seulement les enfants appartiennent directement à ce lgfile. ainsi, le nombre de références peut >= nombre d’importations.

source

Source de la ressource lg. Chemin complet du fichier lg.

Méthodes

addTemplate(string, string[], string)

Ajoutez un nouveau modèle et retournez un fichier LG.

analyzeTemplate(string, AnalyzerOptions)

Analysez un modèle pour obtenir les résultats de l’analyseur statique, y compris les variables et les références de modèle.

deleteTemplate(string)

Supprimez un modèle existant.

evaluate(string, object, EvaluationOptions)

Évaluez un modèle avec un nom et une étendue donnés.

evaluateText(string, object, EvaluationOptions)

Permet d’évaluer un str de modèle inline.

expandTemplate(string, object, EvaluationOptions)

Développez un modèle avec un nom et une étendue donnés. Retourne toutes les réponses possibles au lieu d’une réponse aléatoire.

parseFile(string, ImportResolverDelegate, ExpressionParser)

Analysez un fichier et retournez le fichier LG.

parseResource(LGResource, ImportResolverDelegate, ExpressionParser)

Analyseur pour transformer le contenu lg en modèles.

parseText(string, string, ImportResolverDelegate, ExpressionParser)

Analyseur pour transformer le contenu lg en modèles.

push(Template[])

Ajoute 1 ou plusieurs modèles à la collection.

toArray()

Obtient la collection de modèles.

toString()

Retourne une représentation sous forme de chaîne d’un contenu Templates.

updateTemplate(string, string, string[], string)

Mettez à jour un modèle et retournez un fichier LG.

Détails du constructeur

Templates(Template[], TemplateImport[], Diagnostic[], Templates[], string, string, ExpressionParser, ImportResolverDelegate, string[], string, Record<string, Templates>)

Crée une instance de la classe templates .

new Templates(items?: Template[], imports?: TemplateImport[], diagnostics?: Diagnostic[], references?: Templates[], content?: string, id?: string, expressionParser?: ExpressionParser, importResolverDelegate?: ImportResolverDelegate, options?: string[], source?: string, namedReferences?: Record<string, Templates>)

Paramètres

items

Template[]

Optionnel. Liste des instances modèle.

imports

TemplateImport[]

Optionnel. Liste des instances TemplateImport.

diagnostics

Diagnostic[]

Optionnel. Liste des instances diagnostic.

references

Templates[]

Optionnel. Liste des modèles instances.

content

string

Optionnel. Contenu de l’instance de modèles actuelle.

id

string

Optionnel. ID de l’instance de modèles actuelle.

expressionParser

ExpressionParser

Optionnel. ExpressionParser pour analyser les expressions dans le contenu.

importResolverDelegate
ImportResolverDelegate

Optionnel. Programme de résolution pour résoudre l’ID d’importation LG dans le texte du modèle.

options

string[]

Optionnel. Liste des chaînes représentant les options pendant l’évaluation des modèles.

source

string

Optionnel. Source des modèles.

namedReferences

Record<string, Templates>

Optionnel. Inférences importées avec la syntaxe « as », par exemple : importer en tant que myAlias.

Détails de la propriété

allDiagnostics

Obtient tous les diagnostics du fichier lg actuel et des fichiers lg de référence.

Diagnostic[] allDiagnostics

Valeur de propriété

Tous les diagnostics du fichier lg actuel et des fichiers lg de référence.

allTemplates

Obtient tous les modèles du fichier lg actuel et des fichiers lg de référence.

Template[] allTemplates

Valeur de propriété

Tous les modèles du fichier lg actuel et des fichiers lg de référence.

content

Contenu LG.

content: string

Valeur de propriété

string

diagnostics

diagnostic.

diagnostics: Diagnostic[]

Valeur de propriété

enableFromFile

Indique si fromFile est autorisé dans les modèles LG.

static enableFromFile: boolean = false

Valeur de propriété

boolean

expressionParser

analyseur d’expression.

expressionParser: ExpressionParser

Valeur de propriété

ExpressionParser

id

ID de la ressource lg.

id: string

Valeur de propriété

string

importResolver

Délégué pour la résolution de l’ID de ressource du fichier lg importé.

importResolver: ImportResolverDelegate

Valeur de propriété

imports

importez des éléments que ce fichier LG contient directement.

imports: TemplateImport[]

Valeur de propriété

inlineTemplateIdPrefix

ID de modèle temporaire pour le contenu inline.

static inlineTemplateIdPrefix: string = "__temp__"

Valeur de propriété

string

lgOptions

Obtient les options d’evluation pour le fichier LG actuel. @returns valeur A indiquant si les options lors de l’évaluation des modèles LG.

EvaluationOptions lgOptions

Valeur de propriété

namedReferences

Mappez de l’alias d’importation aux modèles.

namedReferences: Record<string, Templates>

Valeur de propriété

Record<string, Templates>

namespace

Obtient l’espace de noms à inscrire pour le fichier LG actuel. @returns Valeur de chaîne représentant l’espace de noms à inscrire au fichier LG actuel.

string namespace

Valeur de propriété

string

options

Options de fichier LG.

options: string[]

Valeur de propriété

string[]

references

toutes les références que ce fichier LG a de Imports otice : référence inclut toutes les importations enfants à partir du fichier lg, pas seulement les enfants appartiennent directement à ce lgfile. ainsi, le nombre de références peut >= nombre d’importations.

references: Templates[]

Valeur de propriété

source

Source de la ressource lg. Chemin complet du fichier lg.

source: string

Valeur de propriété

string

Détails de la méthode

addTemplate(string, string[], string)

Ajoutez un nouveau modèle et retournez un fichier LG.

function addTemplate(templateName: string, parameters: string[], templateBody: string): Templates

Paramètres

templateName

string

Nouveau nom de modèle.

parameters

string[]

Nouvelles params.

templateBody

string

Nouveau corps du modèle.

Retours

Nouveau fichier lg.

analyzeTemplate(string, AnalyzerOptions)

Analysez un modèle pour obtenir les résultats de l’analyseur statique, y compris les variables et les références de modèle.

function analyzeTemplate(templateName: string, analyzerOptions?: AnalyzerOptions): AnalyzerResult

Paramètres

templateName

string

Nom du modèle à évaluer.

analyzerOptions
AnalyzerOptions

Options d’analyse du modèle.

Retours

Résultat de l’analyseur.

deleteTemplate(string)

Supprimez un modèle existant.

function deleteTemplate(templateName: string): Templates

Paramètres

templateName

string

Quel modèle doit supprimer.

Retours

Retournez le nouveau fichier lg.

evaluate(string, object, EvaluationOptions)

Évaluez un modèle avec un nom et une étendue donnés.

function evaluate(templateName: string, scope?: object, opt: EvaluationOptions): any

Paramètres

templateName

string

Nom du modèle à évaluer.

scope

object

État visible dans l’évaluation.

opt
EvaluationOptions

EvaluationOptions dans l’évaluation d’un modèle.

Retours

any

Évaluez le résultat.

evaluateText(string, object, EvaluationOptions)

Permet d’évaluer un str de modèle inline.

function evaluateText(inlineStr: string, scope?: object, opt: EvaluationOptions): any

Paramètres

inlineStr

string

Chaîne incorporée qui sera évaluée.

scope

object

Objet Scope ou JToken.

opt
EvaluationOptions

EvaluationOptions dans l’évaluation d’un modèle.

Retours

any

Objet de résultat évalué.

expandTemplate(string, object, EvaluationOptions)

Développez un modèle avec un nom et une étendue donnés. Retourne toutes les réponses possibles au lieu d’une réponse aléatoire.

function expandTemplate(templateName: string, scope?: object, opt: EvaluationOptions): any[]

Paramètres

templateName

string

Nom du modèle à évaluer.

scope

object

État visible dans l’évaluation.

opt
EvaluationOptions

EvaluationOptions dans le développement d’un modèle.

Retours

any[]

Développez le résultat.

parseFile(string, ImportResolverDelegate, ExpressionParser)

Analysez un fichier et retournez le fichier LG.

static function parseFile(filePath: string, importResolver?: ImportResolverDelegate, expressionParser?: ExpressionParser): Templates

Paramètres

filePath

string

Chemin d’accès absolu du fichier LG..

importResolver
ImportResolverDelegate

Programme de résolution pour résoudre l’ID d’importation LG dans le texte du modèle.

expressionParser

ExpressionParser

Analyseur d’expression pour l’évaluation des expressions.

Retours

Nouveau fichier lg.

parseResource(LGResource, ImportResolverDelegate, ExpressionParser)

Analyseur pour transformer le contenu lg en modèles.

static function parseResource(resource: LGResource, importResolver?: ImportResolverDelegate, expressionParser?: ExpressionParser): Templates

Paramètres

resource
LGResource

Ressource LG.

importResolver
ImportResolverDelegate

Programme de résolution pour résoudre l’ID d’importation LG dans le texte du modèle.

expressionParser

ExpressionParser

Analyseur d’expression pour l’évaluation des expressions.

Retours

Entité.

parseText(string, string, ImportResolverDelegate, ExpressionParser)

Avertissement

Cette API est à présent déconseillée.

This method will soon be deprecated. Use ParseResource instead.

Analyseur pour transformer le contenu lg en modèles.

static function parseText(content: string, id: string, importResolver?: ImportResolverDelegate, expressionParser?: ExpressionParser): Templates

Paramètres

content

string

Le contenu texte contient des modèles lg.

id

string

L’ID est l’identificateur du contenu. Si importResolver n’est pas défini, l’ID doit être une chaîne de chemin d’accès complète.

importResolver
ImportResolverDelegate

Programme de résolution pour résoudre l’ID d’importation LG dans le texte du modèle.

expressionParser

ExpressionParser

Analyseur d’expression pour l’évaluation des expressions.

Retours

Entité.

push(Template[])

Ajoute 1 ou plusieurs modèles à la collection.

function push(args: Template[])

Paramètres

args

Template[]

Liste des modèles à ajouter.

toArray()

Obtient la collection de modèles.

function toArray(): Template[]

Retours

Référence à la liste interne des modèles de collection.

toString()

Retourne une représentation sous forme de chaîne d’un contenu Templates.

function toString(): string

Retours

string

Représentation sous forme de chaîne d’un contenu Templates.

updateTemplate(string, string, string[], string)

Mettez à jour un modèle et retournez un fichier LG.

function updateTemplate(templateName: string, newTemplateName: string, parameters: string[], templateBody: string): Templates

Paramètres

templateName

string

Nom du modèle orignial.

newTemplateName

string

Nouveau nom de modèle.

parameters

string[]

Nouvelles params.

templateBody

string

Nouveau corps du modèle.

Retours

Nouveau fichier lg.