DefinitelyTyped/types/mpv-script/index.d.ts

// Type definitions for non-npm package mpv-script 0.32
// Project: https://github.com/mpv-player/mpv
// Definitions by: David T <https://github.com/mrxdst>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// Minimum TypeScript Version: 3.4

declare namespace mp {
    type LogLevel = 'fatal' | 'error' | 'warn' | 'info' | 'v' | 'debug' | 'trace';

    interface AddKeyBindingFlags {
        repeatable?: boolean;
        complex?: boolean;
        event?: 'down' | 'repeat' | 'up' | 'press';
        is_mouse?: boolean;
        key_name?: string;
        key_text?: string;
    }

    interface OSDOverlay {
        data: string;
        res_x: number;
        res_y: number;
        z: number;
        update(): void;
        remove(): void;
    }

    interface OSDSize {
        width?: number;
        height?: number;
        aspect?: number;
    }

    interface FileInfo {
        mode: number;
        size: number;
        atime: number;
        mtime: number;
        ctime: number;
        is_file: boolean;
        is_dir: boolean;
    }

    function command(command: string): true | undefined;

    function commandv(...args: ReadonlyArray<string>): true | undefined;

    function command_native(table: unknown, def?: unknown): unknown;

    function command_native_async(
        table: unknown,
        fn?: (success: boolean, result: unknown, error: string | undefined) => void,
    ): unknown;

    function abort_async_command(t: unknown): void;

    function get_property(name: string, def: string): string;
    function get_property(name: string, def?: string): string | undefined;

    function get_property_osd(name: string, def?: string): string;

    function get_property_bool(name: string, def: boolean): boolean;
    function get_property_bool(name: string, def?: boolean): boolean | undefined;

    function get_property_number(name: string, def: number): number;
    function get_property_number(name: string, def?: number): number | undefined;

    function get_property_native(name: string, def?: unknown): unknown;

    function set_property(name: string, value: string): true | undefined;

    function set_property_bool(name: string, value: boolean): true | undefined;

    function set_property_number(name: string, value: number): true | undefined;

    function set_property_native(name: string, value: unknown): true | undefined;

    function get_time(): number;

    function add_key_binding(key: string, name?: string, fn?: () => void, flags?: AddKeyBindingFlags): void;

    function add_forced_key_binding(key: string, name?: string, fn?: () => void, flags?: AddKeyBindingFlags): void;

    function remove_key_binding(name: string): void;

    function register_event(name: string, fn: (event: Record<string, unknown>) => void): void;

    function unregister_event(fn: (...args: unknown[]) => void): void;

    function observe_property(name: string, type: 'native', fn: (name: string, value: unknown) => void): void;
    function observe_property(name: string, type: 'bool', fn: (name: string, value: boolean | undefined) => void): void;
    function observe_property(
        name: string,
        type: 'string',
        fn: (name: string, value: string | undefined) => void,
    ): void;
    function observe_property(
        name: string,
        type: 'number',
        fn: (name: string, value: number | undefined) => void,
    ): void;
    function observe_property(name: string, type: 'none' | undefined, fn: (name: string) => void): void;

    function unobserve_property(fn: (...args: unknown[]) => void): void;

    function get_opt(key: string): string;

    function get_script_name(): string;

    function osd_message(text: string, duration?: number): void;

    function register_idle(fn: () => void): void;

    function unregister_idle(fn: () => void): void;

    function enable_messages(level: LogLevel): void;

    function register_script_message(name: string, fn: (...args: unknown[]) => void): void;

    function unregister_script_message(name: string): void;

    function create_osd_overlay(format: 'ass-events'): OSDOverlay;

    function get_osd_size(): OSDSize | undefined;

    function add_hook(name: string, priority: number, fn: () => void): void;

    function last_error(): string;

    function get_time_ms(): number;

    function get_script_file(): string;

    let module_paths: string[];

    namespace msg {
        function log(level: LogLevel, ...msg: unknown[]): void;

        function fatal(...msg: unknown[]): void;

        function error(...msg: unknown[]): void;

        function warn(...msg: unknown[]): void;

        function info(...msg: unknown[]): void;

        function verbose(...msg: unknown[]): void;

        function debug(...msg: unknown[]): void;

        function trace(...msg: unknown[]): void;
    }

    namespace options {
        function read_options(
            table: Record<string, string | boolean | number>,
            identifier?: string,
            on_update?: (list: Record<string, boolean | undefined>) => void,
        ): void;
    }

    namespace utils {
        function getcwd(): string | undefined;

        function readdir(path: string, filter?: 'files' | 'dirs' | 'normal' | 'all'): string[] | undefined;

        function file_info(path: string): FileInfo | undefined;

        function split_path(path: string): [string, string];

        function join_path(p1: string, p2: string): string;

        function getpid(): number;

        function getenv(name: string): string | undefined;

        function get_user_path(path: string): string;

        function read_file(fname: string, max?: number): string;

        function write_file(fname: string, str: string): void;

        function compile_js(fname: string, content_str: string): (...args: unknown[]) => unknown;
    }
}

declare function print(...msg: unknown[]): void;

declare function dump(...msg: unknown[]): void;

declare function exit(): void;