light-characteristics/dist/defintions.d.ts

🛥️🔦 A parser for light characteristics used on nautical charts

export declare const COLOURS: {
    /**  1 */ W: string;
    /**  2 */ B: string;
    /**  3 */ R: string;
    /**  4 */ G: string;
    /**  5 */ Bu: string;
    /**  6 */ Y: string;
    /**  7 */ Gy: string;
    /**  8 */ Br: string;
    /**  9 */ A: string;
    /** 10 */ V: string;
    /** 11 */ O: string;
    /** 12 */ M: string;
    /** 12 */ P: string;
};
export type Colour = keyof typeof COLOURS;
export declare const LIGHT_CATEGORIES: {
    /**  1 */ directional: string;
    /**  2 DEPRECATED: rear/upper light */
    /**  3 DEPRECATED: front/lower light */
    /**  4 */ leading: string;
    /**  5 */ aero: string;
    /**  6 */ air_obstruction: string;
    /**  7 */ fog_detector: string;
    /**  8 */ floodlight: string;
    /**  9 */ strip_light: string;
    /** 10 */ subsidiary: string;
    /** 11 */ spotlight: string;
    /** 12 */ front: string;
    /** 13 */ rear: string;
    /** 14 */ lower: string;
    /** 15 */ upper: string;
    /** 16 */ moire: string;
    /** 17 */ emergency: string;
    /** 18 */ bearing: string;
    /** 19 */ horizontal: string;
    /** 20 */ vertical: string;
};
export type LightCategory = keyof typeof LIGHT_CATEGORIES;
export declare const LIGHT_CHARACTERISTICS: {
    /**  1 */ F: string;
    /**  2 */ Fl: string;
    /**  3 */ LFl: string;
    /**  4 */ Q: string;
    /**  5 */ VQ: string;
    /**  6 */ UQ: string;
    /**  7 */ Iso: string;
    /**  8 */ Oc: string;
    /**  9 */ IQ: string;
    /** 10 */ IVQ: string;
    /** 11 */ IUQ: string;
    /** 12 */ Mo: string;
    /** 13 */ FFl: string;
    /** 14 */ FlLFl: string;
    /** 15 */ OcFl: string;
    /** 16 */ FLFl: string;
    /** 17 */ 'Al.Oc': string;
    /** 18 */ 'Al.LFl': string;
    /** 19 */ 'Al.Fl': string;
    /** 20 */ 'Al.Gr': string;
    /** 21 DEPRECATED: 2 fixed (vertical)
    /** 22 DEPRECATED: 2 fixed (horizontal)
    /** 23 DEPRECATED: 3 fixed (vertical)
    /** 24 DEPRECATED: 3 fixed (horizontal)
    /** 25 */ 'Q+LFl': string;
    /** 26 */ 'VQ+LFl': string;
    /** 27 */ 'UQ+LFl': string;
    /** 28 */ Al: string;
    /** 29 */ 'Al.FFl': string;
};
export type LightCharacteristic = keyof typeof LIGHT_CHARACTERISTICS;
export interface Light {
    /** Light Category */
    CATLIT?: LightCategory;
    /** Multiplicity: the number of lights */
    MLTYLT?: number;
    /**
     * Signal group: Either:
     *  - The number of flashes, or
     *  - The combination of flashes, or
     *  - The morse-code characters.
     */
    SIGGRP?: string;
    /** Light characteristic */
    LITCHR: LightCharacteristic;
    /** Colour(s) */
    COLOUR: Colour[];
    /**
     * Signal period (in seconds):
     * The time for one entire cycle of the light's pattern
     */
    SIGPER?: number;
    /** Focal height (in metres) */
    HEIGHT?: number;
    /**
     * Value of maximum range (in nautical miles):
     * The furthest distance that the light can be seen.
     */
    VALMXR?: number;
}