[C] JsonSchemaEmitter

Extends

• TypeEmitter<Record<string, any>, JSONSchemaEmitterOptions>

Properties

Property	Modifier	Type	Inherited from
emitter	protected	AssetEmitter<Record<string, any>, JSONSchemaEmitterOptions>	TypeEmitter.emitter

Methods

arrayDeclaration()

arrayDeclaration(
   array,
   name,
elementType): EmitterOutput<object>

Parameters

Parameter	Type
array	Model
name	string
elementType	Type

Returns

EmitterOutput<object>

Overrides

TypeEmitter.arrayDeclaration

---

arrayDeclarationContext()

arrayDeclarationContext(array): Context

Parameters

Parameter	Type
array	Model

Returns

Context

Overrides

TypeEmitter.arrayDeclarationContext

---

arrayDeclarationReferenceContext()

arrayDeclarationReferenceContext(
   array,
   name,
   elementType): Context

Parameters

Parameter	Type
array	Model
name	string
elementType	Type

Returns

Context

Inherited from

TypeEmitter.arrayDeclarationReferenceContext

---

arrayLiteral()

arrayLiteral(array, elementType): EmitterOutput<object>

Parameters

Parameter	Type
array	Model
elementType	Type

Returns

EmitterOutput<object>

Overrides

TypeEmitter.arrayLiteral

---

arrayLiteralContext()

arrayLiteralContext(array, elementType): Context

Parameters

Parameter	Type
array	Model
elementType	Type

Returns

Context

Inherited from

TypeEmitter.arrayLiteralContext

---

arrayLiteralReferenceContext()

arrayLiteralReferenceContext(array, elementType): Context

Parameters

Parameter	Type
array	Model
elementType	Type

Returns

Context

Inherited from

TypeEmitter.arrayLiteralReferenceContext

---

booleanLiteral()

booleanLiteral(boolean): EmitterOutput<object>

Parameters

Parameter	Type
boolean	BooleanLiteral

Returns

EmitterOutput<object>

Overrides

TypeEmitter.booleanLiteral

---

booleanLiteralContext()

booleanLiteralContext(boolean): Context

Parameters

Parameter	Type
boolean	BooleanLiteral

Returns

Context

Inherited from

TypeEmitter.booleanLiteralContext

---

circularReference()

circularReference(
   target,
   scope,
cycle): Record<string, any> | EmitEntity<Record<string, any>>

Handle circular references. When this method is called it means we are resolving a circular reference. By default if the target is a declaration it will call to reference otherwise it means we have an inline reference

Parameters

Parameter	Type	Description
target	EmitEntity<Record<string, any>>	Reference target.
scope	undefined | Scope<Record<string, any>>	Current scope.
cycle	ReferenceCycle	-

Returns

Record<string, any> | EmitEntity<Record<string, any>>

Resolved reference entity.

Inherited from

TypeEmitter.circularReference

---

declarationName()

declarationName(declarationType): undefined | string

Parameters

Parameter	Type
declarationType	TypeSpecDeclaration

Returns

undefined | string

Inherited from

TypeEmitter.declarationName

---

enumDeclaration()

enumDeclaration(en, name): EmitterOutput<object>

Parameters

Parameter	Type
en	Enum
name	string

Returns

EmitterOutput<object>

Overrides

TypeEmitter.enumDeclaration

---

enumDeclarationContext()

enumDeclarationContext(en): Context

Parameters

Parameter	Type
en	Enum

Returns

Context

Overrides

TypeEmitter.enumDeclarationContext

---

enumDeclarationReferenceContext()

enumDeclarationReferenceContext(en, name): Context

Parameters

Parameter	Type
en	Enum
name	string

Returns

Context

Inherited from

TypeEmitter.enumDeclarationReferenceContext

---

enumMember()

enumMember(member): EmitterOutput<Record<string, any>>

Parameters

Parameter	Type
member	EnumMember

Returns

EmitterOutput<Record<string, any>>

Inherited from

TypeEmitter.enumMember

---

enumMemberContext()

enumMemberContext(member): object

Parameters

Parameter	Type
member	EnumMember

Returns

object

Inherited from

TypeEmitter.enumMemberContext

---

enumMemberReference()

enumMemberReference(member): EmitterOutput<Record<string, any>>

Emit an enum member reference (e.g. as created by the SomeEnum.member syntax in TypeSpec). By default, this will emit nothing.

Parameters

Parameter	Type
member	EnumMember

Returns

EmitterOutput<Record<string, any>>

Overrides

TypeEmitter.enumMemberReference

---

enumMembers()

enumMembers(en): EmitterOutput<Record<string, any>>

Parameters

Parameter	Type
en	Enum

Returns

EmitterOutput<Record<string, any>>

Inherited from

TypeEmitter.enumMembers

---

enumMembersContext()

enumMembersContext(en): Context

Parameters

Parameter	Type
en	Enum

Returns

Context

Inherited from

TypeEmitter.enumMembersContext

---

interfaceDeclaration()

interfaceDeclaration(iface, name): EmitterOutput<Record<string, any>>

Parameters

Parameter	Type
iface	Interface
name	string

Returns

EmitterOutput<Record<string, any>>

Inherited from

TypeEmitter.interfaceDeclaration

---

interfaceDeclarationContext()

interfaceDeclarationContext(iface, name): Context

Parameters

Parameter	Type
iface	Interface
name	string

Returns

Context

Inherited from

TypeEmitter.interfaceDeclarationContext

---

interfaceDeclarationOperations()

interfaceDeclarationOperations(iface): EmitterOutput<Record<string, any>>

Parameters

Parameter	Type
iface	Interface

Returns

EmitterOutput<Record<string, any>>

Inherited from

TypeEmitter.interfaceDeclarationOperations

---

interfaceDeclarationOperationsContext()

interfaceDeclarationOperationsContext(iface): Context

Parameters

Parameter	Type
iface	Interface

Returns

Context

Inherited from

TypeEmitter.interfaceDeclarationOperationsContext

---

interfaceDeclarationOperationsReferenceContext()

interfaceDeclarationOperationsReferenceContext(iface): Context

Parameters

Parameter	Type
iface	Interface

Returns

Context

Inherited from

TypeEmitter.interfaceDeclarationOperationsReferenceContext

---

interfaceDeclarationReferenceContext()

interfaceDeclarationReferenceContext(iface, name): Context

Parameters

Parameter	Type
iface	Interface
name	string

Returns

Context

Inherited from

TypeEmitter.interfaceDeclarationReferenceContext

---

interfaceOperationDeclaration()

interfaceOperationDeclaration(operation, name): EmitterOutput<Record<string, any>>

Parameters

Parameter	Type
operation	Operation
name	string

Returns

EmitterOutput<Record<string, any>>

Inherited from

TypeEmitter.interfaceOperationDeclaration

---

interfaceOperationDeclarationContext()

interfaceOperationDeclarationContext(operation, name): Context

Parameters

Parameter	Type
operation	Operation
name	string

Returns

Context

Inherited from

TypeEmitter.interfaceOperationDeclarationContext

---

interfaceOperationDeclarationReferenceContext()

interfaceOperationDeclarationReferenceContext(operation, name): Context

Parameters

Parameter	Type
operation	Operation
name	string

Returns

Context

Inherited from

TypeEmitter.interfaceOperationDeclarationReferenceContext

---

intrinsic()

intrinsic(intrinsic, name): EmitterOutput<object>

Parameters

Parameter	Type
intrinsic	IntrinsicType
name	string

Returns

EmitterOutput<object>

Overrides

TypeEmitter.intrinsic

---

intrinsicContext()

intrinsicContext(intrinsic, name): Context

Parameters

Parameter	Type
intrinsic	IntrinsicType
name	string

Returns

Context

Inherited from

TypeEmitter.intrinsicContext

---

modelDeclaration()

modelDeclaration(model, name): EmitterOutput<object>

Emit a model declaration (e.g. as created by model Foo { } syntax in TypeSpec).

Parameters

Parameter	Type	Description
model	Model
name	string	-

Returns

EmitterOutput<object>

Overrides

TypeEmitter.modelDeclaration

---

modelDeclarationContext()

modelDeclarationContext(model, name): Context

Set lexical context for a model declaration.

Parameters

Parameter	Type	Description
model	Model
name	string	the model’s declaration name as retrieved from the declarationName method.

Returns

Context

Overrides

TypeEmitter.modelDeclarationContext

---

modelDeclarationReferenceContext()

modelDeclarationReferenceContext(model, name): Context

Set reference context for a model declaration.

Parameters

Parameter	Type	Description
model	Model
name	string	-

Returns

Context

Inherited from

TypeEmitter.modelDeclarationReferenceContext

---

modelInstantiation()

modelInstantiation(model, name): EmitterOutput<Record<string, any>>

Emit a model instantiation (e.g. as created by Box<string> syntax in TypeSpec). In some cases, name is undefined because a good name could not be found for the instantiation. This often occurs with for instantiations involving type expressions like Box<string | int32>.

Parameters

Parameter	Type	Description
model	Model
name	undefined | string	The name of the instantiation as retrieved from the declarationName method.

Returns

EmitterOutput<Record<string, any>>

Overrides

TypeEmitter.modelInstantiation

---

modelInstantiationContext()

modelInstantiationContext(model, name): Context

Set lexical context for a model instantiation.

Parameters

Parameter	Type	Description
model	Model
name	undefined | string	-

Returns

Context

Overrides

TypeEmitter.modelInstantiationContext

---

modelInstantiationReferenceContext()

modelInstantiationReferenceContext(model, name): Context

Set reference context for a model declaration.

Parameters

Parameter	Type	Description
model	Model
name	undefined | string	-

Returns

Context

Inherited from

TypeEmitter.modelInstantiationReferenceContext

---

modelLiteral()

modelLiteral(model): EmitterOutput<object>

Emit a model literal (e.g. as created by {} syntax in TypeSpec).

Parameters

Parameter	Type	Description
model	Model

Returns

EmitterOutput<object>

Overrides

TypeEmitter.modelLiteral

---

modelLiteralContext()

modelLiteralContext(model): Context

Set lexical context for a model literal.

Parameters

Parameter	Type	Description
model	Model

Returns

Context

Inherited from

TypeEmitter.modelLiteralContext

---

modelLiteralReferenceContext()

modelLiteralReferenceContext(model): Context

Set reference context for a model literal.

Parameters

Parameter	Type	Description
model	Model

Returns

Context

Inherited from

TypeEmitter.modelLiteralReferenceContext

---

modelProperties()

modelProperties(model): EmitterOutput<object>

Emit a model’s properties. Unless overridden, this method will emit each of the model’s properties and return a no emit result.

Parameters

Parameter	Type	Description
model	Model

Returns

EmitterOutput<object>

Overrides

TypeEmitter.modelProperties

---

modelPropertiesContext()

modelPropertiesContext(model): Context

Parameters

Parameter	Type
model	Model

Returns

Context

Inherited from

TypeEmitter.modelPropertiesContext

---

modelPropertiesReferenceContext()

modelPropertiesReferenceContext(model): Context

Parameters

Parameter	Type
model	Model

Returns

Context

Inherited from

TypeEmitter.modelPropertiesReferenceContext

---

modelPropertyLiteral()

modelPropertyLiteral(property): EmitterOutput<object>

Emit a property of a model.

Parameters

Parameter	Type	Description
property	ModelProperty

Returns

EmitterOutput<object>

Overrides

TypeEmitter.modelPropertyLiteral

---

modelPropertyLiteralContext()

modelPropertyLiteralContext(property): Context

Set lexical context for a property of a model.

Parameters

Parameter	Type	Description
property	ModelProperty

Returns

Context

Inherited from

TypeEmitter.modelPropertyLiteralContext

---

modelPropertyLiteralReferenceContext()

modelPropertyLiteralReferenceContext(property): Context

Set reference context for a property of a model.

Parameters

Parameter	Type	Description
property	ModelProperty

Returns

Context

Inherited from

TypeEmitter.modelPropertyLiteralReferenceContext

---

modelPropertyReference()

modelPropertyReference(property): EmitterOutput<object>

Emit a model property reference (e.g. as created by the SomeModel.prop syntax in TypeSpec). By default, this will emit the type of the referenced property and return that result. In other words, the emit will look as if SomeModel.prop were replaced with the type of prop.

Parameters

Parameter	Type	Description
property	ModelProperty

Returns

EmitterOutput<object>

Overrides

TypeEmitter.modelPropertyReference

---

namespace()

namespace(namespace): EmitterOutput<Record<string, any>>

Emit a namespace

Parameters

Parameter	Type	Description
namespace	Namespace

Returns

EmitterOutput<Record<string, any>>

Emitter output

Inherited from

TypeEmitter.namespace

---

namespaceContext()

namespaceContext(namespace): Context

Set lexical context for a namespace

Parameters

Parameter	Type	Description
namespace	Namespace

Returns

Context

Inherited from

TypeEmitter.namespaceContext

---

namespaceReferenceContext()

namespaceReferenceContext(namespace): Context

Set reference context for a namespace.

Parameters

Parameter	Type	Description
namespace	Namespace

Returns

Context

Inherited from

TypeEmitter.namespaceReferenceContext

---

numericLiteral()

numericLiteral(number): EmitterOutput<object>

Parameters

Parameter	Type
number	NumericLiteral

Returns

EmitterOutput<object>

Overrides

TypeEmitter.numericLiteral

---

numericLiteralContext()

numericLiteralContext(number): Context

Parameters

Parameter	Type
number	NumericLiteral

Returns

Context

Inherited from

TypeEmitter.numericLiteralContext

---

operationDeclaration()

operationDeclaration(operation, name): EmitterOutput<Record<string, any>>

Parameters

Parameter	Type
operation	Operation
name	string

Returns

EmitterOutput<Record<string, any>>

Inherited from

TypeEmitter.operationDeclaration

---

operationDeclarationContext()

operationDeclarationContext(operation, name): Context

Parameters

Parameter	Type
operation	Operation
name	string

Returns

Context

Inherited from

TypeEmitter.operationDeclarationContext

---

operationDeclarationReferenceContext()

operationDeclarationReferenceContext(operation, name): Context

Parameters

Parameter	Type
operation	Operation
name	string

Returns

Context

Inherited from

TypeEmitter.operationDeclarationReferenceContext

---

operationParameters()

operationParameters(operation, parameters): EmitterOutput<Record<string, any>>

Parameters

Parameter	Type
operation	Operation
parameters	Model

Returns

EmitterOutput<Record<string, any>>

Inherited from

TypeEmitter.operationParameters

---

operationParametersContext()

operationParametersContext(operation, parameters): Context

Parameters

Parameter	Type
operation	Operation
parameters	Model

Returns

Context

Inherited from

TypeEmitter.operationParametersContext

---

operationParametersReferenceContext()

operationParametersReferenceContext(operation, parameters): Context

Parameters

Parameter	Type
operation	Operation
parameters	Model

Returns

Context

Inherited from

TypeEmitter.operationParametersReferenceContext

---

operationReturnType()

operationReturnType(operation, returnType): EmitterOutput<Record<string, any>>

Parameters

Parameter	Type
operation	Operation
returnType	Type

Returns

EmitterOutput<Record<string, any>>

Inherited from

TypeEmitter.operationReturnType

---

operationReturnTypeContext()

operationReturnTypeContext(operation, returnType): Context

Parameters

Parameter	Type
operation	Operation
returnType	Type

Returns

Context

Inherited from

TypeEmitter.operationReturnTypeContext

---

operationReturnTypeReferenceContext()

operationReturnTypeReferenceContext(operation, returnType): Context

Parameters

Parameter	Type
operation	Operation
returnType	Type

Returns

Context

Inherited from

TypeEmitter.operationReturnTypeReferenceContext

---

programContext()

programContext(program): Context

Context shared by the entire program. In cases where you are emitting to a single file, use this method to establish your main source file and set the scope property to that source file’s globalScope.

Parameters

Parameter	Type	Description
program	Program

Returns

Context

Context

Inherited from

TypeEmitter.programContext

---

reference()

reference(
   targetDeclaration,
   pathUp,
   pathDown,
commonScope): object | EmitEntity<Record<string, unknown>>

Parameters

Parameter	Type
targetDeclaration	Declaration<Record<string, unknown>>
pathUp	Scope<Record<string, unknown>>[]
pathDown	Scope<Record<string, unknown>>[]
commonScope	null | Scope<Record<string, unknown>>

Returns

object | EmitEntity<Record<string, unknown>>

Overrides

TypeEmitter.reference

---

scalarDeclaration()

scalarDeclaration(scalar, name): EmitterOutput<object>

Parameters

Parameter	Type
scalar	Scalar
name	string

Returns

EmitterOutput<object>

Overrides

TypeEmitter.scalarDeclaration

---

scalarDeclarationContext()

scalarDeclarationContext(scalar): Context

Parameters

Parameter	Type
scalar	Scalar

Returns

Context

Overrides

TypeEmitter.scalarDeclarationContext

---

scalarDeclarationReferenceContext()

scalarDeclarationReferenceContext(scalar, name): Context

Parameters

Parameter	Type
scalar	Scalar
name	string

Returns

Context

Inherited from

TypeEmitter.scalarDeclarationReferenceContext

---

scalarInstantiation()

scalarInstantiation(scalar, name): EmitterOutput<Record<string, any>>

Parameters

Parameter	Type
scalar	Scalar
name	undefined | string

Returns

EmitterOutput<Record<string, any>>

Overrides

TypeEmitter.scalarInstantiation

---

scalarInstantiationContext()

scalarInstantiationContext(scalar, name): Context

Parameters

Parameter	Type
scalar	Scalar
name	undefined | string

Returns

Context

Overrides

TypeEmitter.scalarInstantiationContext

---

sourceFile()

sourceFile(sourceFile): EmittedSourceFile

Parameters

Parameter	Type
sourceFile	SourceFile<object>

Returns

EmittedSourceFile

Overrides

TypeEmitter.sourceFile

---

stringLiteral()

stringLiteral(string): EmitterOutput<object>

Parameters

Parameter	Type
string	StringLiteral

Returns

EmitterOutput<object>

Overrides

TypeEmitter.stringLiteral

---

stringLiteralContext()

stringLiteralContext(string): Context

Parameters

Parameter	Type
string	StringLiteral

Returns

Context

Inherited from

TypeEmitter.stringLiteralContext

---

stringTemplate()

stringTemplate(string): EmitterOutput<object>

Parameters

Parameter	Type
string	StringTemplate

Returns

EmitterOutput<object>

Overrides

TypeEmitter.stringTemplate

---

stringTemplateContext()

stringTemplateContext(string): Context

Parameters

Parameter	Type
string	StringTemplate

Returns

Context

Inherited from

TypeEmitter.stringTemplateContext

---

tupleLiteral()

tupleLiteral(tuple): EmitterOutput<Record<string, any>>

Parameters

Parameter	Type
tuple	Tuple

Returns

EmitterOutput<Record<string, any>>

Overrides

TypeEmitter.tupleLiteral

---

tupleLiteralContext()

tupleLiteralContext(tuple): Context

Parameters

Parameter	Type
tuple	Tuple

Returns

Context

Inherited from

TypeEmitter.tupleLiteralContext

---

tupleLiteralReferenceContext()

tupleLiteralReferenceContext(tuple): Context

Parameters

Parameter	Type
tuple	Tuple

Returns

Context

Inherited from

TypeEmitter.tupleLiteralReferenceContext

---

tupleLiteralValues()

tupleLiteralValues(tuple): EmitterOutput<Record<string, any>>

Parameters

Parameter	Type
tuple	Tuple

Returns

EmitterOutput<Record<string, any>>

Overrides

TypeEmitter.tupleLiteralValues

---

tupleLiteralValuesContext()

tupleLiteralValuesContext(tuple): Context

Parameters

Parameter	Type
tuple	Tuple

Returns

Context

Inherited from

TypeEmitter.tupleLiteralValuesContext

---

tupleLiteralValuesReferenceContext()

tupleLiteralValuesReferenceContext(tuple): Context

Parameters

Parameter	Type
tuple	Tuple

Returns

Context

Inherited from

TypeEmitter.tupleLiteralValuesReferenceContext

---

unionDeclaration()

unionDeclaration(union, name): EmitterOutput<object>

Parameters

Parameter	Type
union	Union
name	string

Returns

EmitterOutput<object>

Overrides

TypeEmitter.unionDeclaration

---

unionDeclarationContext()

unionDeclarationContext(union): Context

Parameters

Parameter	Type
union	Union

Returns

Context

Overrides

TypeEmitter.unionDeclarationContext

---

unionDeclarationReferenceContext()

unionDeclarationReferenceContext(union): Context

Parameters

Parameter	Type
union	Union

Returns

Context

Inherited from

TypeEmitter.unionDeclarationReferenceContext

---

unionInstantiation()

unionInstantiation(union, name): EmitterOutput<Record<string, any>>

Parameters

Parameter	Type
union	Union
name	string

Returns

EmitterOutput<Record<string, any>>

Inherited from

TypeEmitter.unionInstantiation

---

unionInstantiationContext()

unionInstantiationContext(union, name): Context

Parameters

Parameter	Type
union	Union
name	string

Returns

Context

Inherited from

TypeEmitter.unionInstantiationContext

---

unionInstantiationReferenceContext()

unionInstantiationReferenceContext(union, name): Context

Parameters

Parameter	Type
union	Union
name	string

Returns

Context

Inherited from

TypeEmitter.unionInstantiationReferenceContext

---

unionLiteral()

unionLiteral(union): EmitterOutput<object>

Parameters

Parameter	Type
union	Union

Returns

EmitterOutput<object>

Overrides

TypeEmitter.unionLiteral

---

unionLiteralContext()

unionLiteralContext(union): Context

Parameters

Parameter	Type
union	Union

Returns

Context

Inherited from

TypeEmitter.unionLiteralContext

---

unionLiteralReferenceContext()

unionLiteralReferenceContext(union): Context

Parameters

Parameter	Type
union	Union

Returns

Context

Inherited from

TypeEmitter.unionLiteralReferenceContext

---

unionVariant()

unionVariant(variant): EmitterOutput<object>

Parameters

Parameter	Type
variant	UnionVariant

Returns

EmitterOutput<object>

Overrides

TypeEmitter.unionVariant

---

unionVariantContext()

unionVariantContext(union): Context

Parameters

Parameter	Type
union	Union

Returns

Context

Inherited from

TypeEmitter.unionVariantContext

---

unionVariantReferenceContext()

unionVariantReferenceContext(union): Context

Parameters

Parameter	Type
union	Union

Returns

Context

Inherited from

TypeEmitter.unionVariantReferenceContext

---

unionVariants()

unionVariants(union): EmitterOutput<object>

Parameters

Parameter	Type
union	Union

Returns

EmitterOutput<object>

Overrides

TypeEmitter.unionVariants

---

unionVariantsContext()

unionVariantsContext(): Context

Returns

Context

Inherited from

TypeEmitter.unionVariantsContext

---

unionVariantsReferenceContext()

unionVariantsReferenceContext(): Context

Returns

Context

Inherited from

TypeEmitter.unionVariantsReferenceContext

---

writeOutput()

writeOutput(sourceFiles): Promise<void>

Parameters

Parameter	Type
sourceFiles	SourceFile<Record<string, any>>[]

Returns

Promise<void>

Overrides

TypeEmitter.writeOutput