lux-framework/src/packages/server/request/interfaces.js

Build scalable, Node.js-powered REST APIs with almost no code.

// @flow
import type Logger from '../../logger';
import type Router, { Route } from '../../router';
import type Controller from '../../controller';

export type Request$opts = {
  logger: Logger;
  router: Router;
};

type Request$url = {
  protocol?: string;
  slashes?: boolean;
  auth?: string;
  host?: string;
  port?: string;
  hostname?: string;
  hash?: string;
  search?: string;
  params: Array<string>;
  query: Object;
  pathname: string;
  path: string;
  href: string;
};

export type Request$method =
  | 'GET'
  | 'HEAD'
  | 'OPTIONS'
  | 'PATCH'
  | 'POST'
  | 'DELETE';

export type Request$params = {
  id: number | string | Buffer;
  sort: string;
  filter: Object;
  fields: Object;
  include: Array<string>;

  page: {
    size?: number;
    number?: number;
  };

  data: {
    id: number | string | Buffer;
    type: string;
    attributes?: Object;
    relationships?: Object;
  };
};

declare export class Request extends stream$Readable {
  headers: Map<string, string>;
  httpVersion: string;
  method: Request$method;
  trailers: Object;
  socket: net$Socket;
  logger: Logger;
  params: Request$params;
  defaultParams: Request$params;
  route: Route;
  action: string;
  controller: Controller;
  url: Request$url;

  connection: {
    encrypted: boolean;
    remoteAddress: string;
  };

  setTimeout(msecs: number, callback: Function): void
}