W3cubDocs

/Haxe

Typedef

package haxe.rtti

import haxe.rtti.CType

Available on all platforms

The typedef runtime information.

Fields

types:Map<String, CType>

The types of the typedef, by platform.

type:CType

The type of the typedef.

platforms:Platforms

A list of strings representing the targets where the type is available.

path:Path

The type path of the type.

params:TypeParams

An array of strings representing the names of the type parameters the type has.

module:Path

The type path of the module containing the type.

meta:MetaData

The [metadata](https://haxe.org/manual/lf-metadata.html) the type was annotated with.

isPrivate:Bool

Whether or not the type is [`private`](https://haxe.org/manual/type-system-module-sub-types.html#define-private-type).

file:Null<String>

The full slash path of the .hx file containing the type. This might be `null` in case there is no such file, e.g. if the type is defined through a macro.

doc:Null<String>

The documentation of the type. This information is only available if the compiler flag `-D use_rtti_doc` was in place. Otherwise, or if the constructor has no documentation, the value is `null`.

© 2005–2020 Haxe Foundation
Licensed under a MIT license.
https://api.haxe.org/haxe/rtti/Typedef.html