@vepler/schools-types
Version:
TypeScript type definitions for Vepler Schools Service
21 lines (20 loc) • 648 B
TypeScript
/**
* Attribute Model Interface
*
* Represents school attributes used for various metrics.
*/
/** Available attribute types */
export declare const AttributeTypes: readonly ["ks2", "ks4", "pupil", "ks5"];
/** Type for attribute types - either KS2, KS4, pupil admission, or KS5 */
export type AttributeType = typeof AttributeTypes[number];
/**
* School attribute interface
*/
export interface IAttribute {
/** Type of attribute (KS2, KS4, etc.) */
type: AttributeType;
/** Unique name identifier for the attribute */
name: string;
/** Human-readable description of what the attribute measures */
description: string;
}