declarations/phoenix/phoenix.d.ts

[](https://www.npmjs.com/package/declarations)

// Type definitions for phoenix
// Project: https://github.com/phoenixframework/phoenix
// Definitions by: Mirosław Ciastek <https://github.com/mciastek>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

declare module "phoenix" {
  class Push {
    constructor(channel: Channel, event: string, payload: any, timeout: number);

    resend(timeout: number): void;
    send(): void;

    receive(status: string, callback: (response?: any) => void): Push;
  }

  export class Channel {
    constructor(topic: string, params?: Object, socket?: Socket);

    rejoinUntilConnected(): void;

    join(timeout?: number): Push;
    leave(timeout?: number): Push;

    onClose(callback: Function): void;
    onError(callback: (reason?: any) => void): void;
    onMessage(event: string, payload: any, ref: any): any;

    on(event: string, callback: (response?: any) => void): void;
    off(event: string): void;

    canPush(): boolean;

    push(event: string, payload: Object, timeout?: number): Push;
  }

  export class Socket {
    constructor(endPoint: string, opts?: Object);

    protocol(): string;
    endPointURL(): string;

    disconnect(callback?: Function, code?: string, reason?: any): void;
    connect(params?: any): void;

    log(kind: string, msg: string, data: any): void;

    onOpen(callback: Function): void;
    onClose(callback: Function): void;
    onError(callback: Function): void;
    onMessage(callback: Function): void;

    onConnOpen(): void;
    onConnClose(event: any): void;
    onConnError(error: any): void;

    triggerChanError(): void;

    connectionState(): string;

    isConnected(): boolean;

    remove(channel: Channel): void;
    channel(topic: string, chanParams?: Object): Channel;

    push(data: any): void;

    makeRef(): string;
    sendHeartbeat(): void;
    flushSendBuffer(): void;

    onConnMessage(rawMessage: any): void;
  }

  export class LongPoll {
    constructor(endPoint: string);

    normalizeEndpoint(endPoint: string): string;
    endpointURL(): string;

    closeAndRetry(): void;
    ontimeout(): void;

    poll(): void;

    send(body: any): void;
    close(code?: any, reason?: any): void;
  }

  export class Ajax {
    request(
      method: string,
      endPoint: string,
      accept: string,
      body: any,
      timeout?: number,
      ontimeout?: any,
      callback?: (response?: any) => void
    ): void;

    xdomainRequest(
      req: any,
      method: string,
      endPoint: string,
      body: any,
      timeout?: number,
      ontimeout?: any,
      callback?: (response?: any) => void
    ): void;

    xhrRequest(
      req: any,
      method: string,
      endPoint: string,
      accept: string,
      body: any,
      timeout?: number,
      ontimeout?: any,
      callback?: (response?: any) => void
    ): void;

    parseJSON(resp: string): JSON;
    serialize(obj: any, parentKey: string): string;
    appendParams(url: string, params: any): string;
  }

  export var Presence: {
    syncState(
      currentState: any,
      newState: any,
      onJoin?: (key?: string, currentPresence?: any, newPresence?: any) => void,
      onLeave?: (key?: string, currentPresence?: any, newPresence?: any) => void
    ): any;

    syncDiff(
      currentState: any,
      newState: any,
      onJoin?: (key?: string, currentPresence?: any, newPresence?: any) => void,
      onLeave?: (key?: string, currentPresence?: any, newPresence?: any) => void
    ): any;

    list(presences: any, chooser?: Function): any;
  }
}