Doc comments

This commit is contained in:
EncodedVenom 2024-06-15 15:45:23 -04:00
parent a1b82c7e3b
commit c186dbace0

11
lib/index.d.ts vendored
View file

@ -131,8 +131,19 @@ export class World {
query<T extends Entity[]>(...components: T): Query<InferComponents<T>>;
}
/**
* Creates a composite key.
* @param pred The first entity
* @param obj The second entity
* @returns The composite key
*/
export const pair: (pred: Entity, obj: Entity) => Entity;
/**
* Checks if the entity is a composite key
* @param e The entity to check
* @returns If the entity is a pair
*/
export const IS_PAIR: (e: Entity) => boolean;
export const OnAdd: Entity;