GenerateContext

GenerateContext is an internal object controlling the generate phase. It provides access to schema data and settings inputs. It also receives generated code and writes to File objects.

Properties

Methods

createAndRegisterDefinition

Generates a TypeSystemValue from schema using schemaToValueFn and creates a new Definition using the provided identifier. It then registers the new definition in File object at destinationPath.

If a definition with the name provided by identifier already exists at destinationPath, the existing definition will be retrieved and returned instead of creating a new one.

context.createAndRegisterDefinition({
  schema,
  identifier,
  destinationPath,
  schemaToValueFn
})

Return value

A Definition object with the output of schemaToValueFn function assigned to its value property.

defineAndRegister

Creates a new Definition using the provided identifier and registers it in File object at destinationPath.

If a definition with the name provided by identifier already exists at destinationPath, the existing definition will be retrieved and returned instead of creating a new one.

context.defineAndRegister({
  identifier,
  value,
  destinationPath,
})

Return value

A Definition object with the provided value assigned to its value property.

register

Insert supplied imports and definitions into File at destinationPath.

If an import from a specified module already exists in the file, the import names are appended to the existing module.

Any definitions with with a name that has already been registered at destinationPath will be not be added.

context.register({ imports, definitions })

Return value

Void

insertOperation

Transforms an operation into a Definition using insertable and registers it.

If a Definition with same name already exists at same path, it will be reused.

If Definition is declared outside of destinationPath, it will also get imported to destinationPath.

context.insertOperation({
  insertable,
  operation,
  generation,
  destinationPath,
})

Return value

A new Inserted object.

insertModel

Looks up model by refName, transforms it into a Definition using insertable and registers it.

If a Definition with same name already exists at same path, it will be reused.

If Definition is declared outside of destinationPath, it will also get imported to destinationPath.

context.insertModel({
  insertable,
  refName,
  generation,
  destinationPath
})

Return value

A new Inserted object.

toOperationContentSettings

Creates a new ContentSettings object from settings loaded at runtime and static config methods on insertable object.

context.toOperationContentSettings({ operation, insertable })

Return value

A new ContentSettings object.

toModelContentSettings

Creates a new ContentSettings object from settings loaded at runtime and static config methods on insertable object.

context.toModelContentSettings({ refName, insertable })

Return value

A new ContentSettings object.

toGatewayContentSettings

Creates a new ContentSettings object from settings loaded at runtime and static config methods on gateway object.

context.toGatewayContentSettings(gateway)

Return value

A new ContentSettings object.

resolveSchemaRefOnce

Look up an OasSchema reference by refName and return its value.

context.resolveSchemaRefOnce( refName )

Throws if schema with refName is not found.

Return value

A OasSchema or OasRef object.

findDefinition

Look up a Definition by name at exportPath.

context.findDefinition({ name, exportPath })

Return value

A Definition object or undefined if not found.