Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "superoak"

Index

Functions

Functions

Private isOakApplication

  • isOakApplication(thing: any): boolean

  • Duck typing to determine if is Oak application like.

    Parameters

    • thing: any

    Returns boolean

Private random

  • random(min: number, max: number): number

  • Generates a random number between min and max

    Parameters

    • min: number
    • max: number

    Returns number

superoak

  • superoak(app: string | any, secure?: boolean): Promise<SuperDeno>

  • Takes a url string (for an already running Oak server), or an Oak Application object.

    When passing a url string, accepts an optional second argument of secure to determine whether connections should be over HTTPS (true) or HTTP (false).

    When passing an Oak Application, SuperOak will automatically handle the creation of a server, binding to a free ephemeral port and closing of the server on a call to .end().

    Parameters

    • app: string | any
    • Optional secure: boolean

    Returns Promise<SuperDeno>

Generated using TypeDoc