signalk-server
Version:
An implementation of a [Signal K](http://signalk.org) server for boats.
39 lines • 1.2 kB
TypeScript
import { ServerAPI, WithContext, FullSignalK } from '@signalk/server-api';
import { SecurityStrategy } from './security';
export interface HelloMessage {
name: string;
version: string;
self: string;
roles: string[];
timestamp: Date;
/**
* Unique identifier for this server-process start. A fresh value each
* time the server starts lets reconnecting clients detect that
* server-side state (delta cache, source registry) has been wiped and
* drop their own mirrors of paths the new instance may never re-publish.
*/
serverStartId: string;
}
export type ICallback<T> = (error?: Error | null, result?: T) => void;
export interface SignalKServer extends ServerAPI {
config: {
defaults: any;
};
getHello: () => HelloMessage;
signalk: FullSignalK;
selfId: string;
selfType: string;
securityStrategy: SecurityStrategy;
}
export declare class Interface {
start?: () => void;
stop?: () => void;
mdns?: MdnsAdvertisement;
}
export interface MdnsAdvertisement {
name: string;
type: string;
port: number;
}
export type ContextMatcher = (_: WithContext) => boolean;
//# sourceMappingURL=types.d.ts.map