Class PreModel

constructor

• new PreModel(instance: _PreModel, source: string): PreModel

  Parameters

  • instance: _PreModel
  • source: string

  Returns PreModel

instance

source

StaticfromPreModel

• fromPreModel(preModel: _PreModel): PreModel

  Parameters

  • preModel: _PreModel

  Returns PreModel

serialize

• serialize(): SerializedPreModel

  Serialize the PreModel as a json object

  Returns SerializedPreModel

transform

• transform(
      data?: ConstantEntry[],
      fns?: RoocFunction<[string, SerializedPrimitiveKind][]>[],
  ): Result<Model, TransformError>

  Transforms the PreModel into a Model

  Parameters

  • data: ConstantEntry[] = []

    additional constants added to the runtime
  • fns: RoocFunction<[string, SerializedPrimitiveKind][]>[] = []

    additional functions that can be used in the transformation process

  Returns Result<Model, TransformError>

typeCheck

• typeCheck(
      data?: ConstantEntry[],
      fns?: RoocFunction<[string, SerializedPrimitiveKind][]>[],
  ): Result<null, TransformError>

  Executes type checking on the PreModel, reporting any type errors that are found

  Parameters

  • data: ConstantEntry[] = []

    additional constants added to the runtime
  • fns: RoocFunction<[string, SerializedPrimitiveKind][]>[] = []

    additional functions that can be used in the type checking process

  Returns Result<null, TransformError>

createTypeMap

• createTypeMap(
      data?: ConstantEntry[],
      fns?: RoocFunction<[string, SerializedPrimitiveKind][]>[],
  ): Map<number, SerializedTypedToken>

  Create a type map for the source code provided, the key is the offset of the token in the source code and the type is the type of the token

  Parameters

  • data: ConstantEntry[] = []
  • fns: RoocFunction<[string, SerializedPrimitiveKind][]>[] = []

  Returns Map<number, SerializedTypedToken>

toLatex

• toLatex(): string

  Converts the PreModel into a latex string

  Returns string

format

• format(): string

  Formats the source code

  Returns string