Reflection

Flamework comes with a reflection library which is where all generated metadata is stored.

General API

Flamework follows this proposal for its design.

API

// define metadata on an object or property
Reflect.defineMetadata(metadataKey, metadataValue, target);
Reflect.defineMetadata(metadataKey, metadataValue, target, propertyKey);

// check for presence of a metadata key on the prototype chain of an object or property
let result = Reflect.hasMetadata(metadataKey, target);
let result = Reflect.hasMetadata(metadataKey, target, propertyKey);

// check for presence of an own metadata key of an object or property
let result = Reflect.hasOwnMetadata(metadataKey, target);
let result = Reflect.hasOwnMetadata(metadataKey, target, propertyKey);

// get metadata value of a metadata key on the prototype chain of an object or property
let result = Reflect.getMetadata(metadataKey, target);
let result = Reflect.getMetadata(metadataKey, target, propertyKey);

// get metadata value of an own metadata key of an object or property
let result = Reflect.getOwnMetadata(metadataKey, target);
let result = Reflect.getOwnMetadata(metadataKey, target, propertyKey);

// get all metadata keys on the prototype chain of an object or property
let result = Reflect.getMetadataKeys(target);
let result = Reflect.getMetadataKeys(target, propertyKey);

// get all own metadata keys of an object or property
let result = Reflect.getOwnMetadataKeys(target);
let result = Reflect.getOwnMetadataKeys(target, propertyKey);

// delete metadata from an object or property
let result = Reflect.deleteMetadata(metadataKey, target);
let result = Reflect.deleteMetadata(metadataKey, target, propertyKey);

Flamework API

This is the flamework specific APIs added to the reflection library.

Reflect.getProperties / Reflect.getOwnProperties

function Reflect.getProperties(obj: object): string[]

This function gets the name of every property which has metadata attached.

Reflect.idToObj / Reflect.objToId

const idToObj: Map<string, object>
const objToId: Map<object, string>

These are lookup tables for mapping a constructor to an identifier and vice-versa. These are automatically populated by Flamework and should not be mutated.

Reflect.decorators

const decorators: Map<string, Array<object>>

This is a lookup table which tracks the usage of decorators. You should use Modding.getDecorators instead of this API.

identifier

The Reflect library treats identifier differently from other metadata. It populates Reflect.idToObj and Reflect.objToId as well as verifies uniqueness. You should not assign this manually as Flamework will assign it automatically.