signalk-server/lib/types.d.ts

An implementation of a [Signal K](http://signalk.org) server for boats.

import { WithContext } from '@signalk/server-api';
import { FullSignalK } from '@signalk/signalk-schema';
import { SecurityStrategy } from './security';
import SubscriptionManager from './subscriptionmanager';
export interface HelloMessage {
    name: string;
    version: string;
    self: string;
    roles: string[];
    timestamp: Date;
}
export interface Bus {
    onValue: (callback: (value: any) => any) => () => void;
    push: (v: any) => void;
    scan: (a: any, f: (a: any, b: any) => any | void) => {
        toProperty: () => () => void;
    };
}
export interface StreamBundle {
    keys: {
        onValue: (arg0: (key: any) => void) => void;
    };
    getBus: (path: string) => Bus;
    getAvailablePaths: () => string[];
}
export type ICallback<T> = (error?: Error | null, result?: T) => void;
export interface SignalKServer {
    config: {
        defaults: any;
    };
    handleMessage: (providerId: string, message: any) => void;
    getHello: () => HelloMessage;
    signalk: FullSignalK;
    selfId: string;
    selfType: string;
    subscriptionmanager: SubscriptionManager;
    securityStrategy: SecurityStrategy;
}
export declare class Interface {
    start?: () => void;
    stop?: () => void;
    mdns?: MdnsAdvertisement;
}
export interface MdnsAdvertisement {
    name: string;
    type: string;
    port: number;
}
export type Unsubscribes = Array<() => void>;
export type ContextMatcher = (_: WithContext) => boolean;