Function createNodeblocksAuthApp

Returns {
    _router: any;
    all: IRouterMatcher<Express, "all">;
    checkout: IRouterMatcher<Express, any>;
    connect: IRouterMatcher<Express, any>;
    copy: IRouterMatcher<Express, any>;
    delete: IRouterMatcher<Express, "delete">;
    get: ((name) => any) & IRouterMatcher<Express, any>;
    head: IRouterMatcher<Express, "head">;
    link: IRouterMatcher<Express, any>;
    locals: Record<string, any> & Locals;
    lock: IRouterMatcher<Express, any>;
    m-search: IRouterMatcher<Express, any>;
    map: any;
    merge: IRouterMatcher<Express, any>;
    mkactivity: IRouterMatcher<Express, any>;
    mkcol: IRouterMatcher<Express, any>;
    mountpath: string | string[];
    move: IRouterMatcher<Express, any>;
    notify: IRouterMatcher<Express, any>;
    on: ((event, callback) => this);
    options: IRouterMatcher<Express, "options">;
    patch: IRouterMatcher<Express, "patch">;
    post: IRouterMatcher<Express, "post">;
    propfind: IRouterMatcher<Express, any>;
    proppatch: IRouterMatcher<Express, any>;
    purge: IRouterMatcher<Express, any>;
    put: IRouterMatcher<Express, "put">;
    report: IRouterMatcher<Express, any>;
    request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>;
    resource: any;
    response: Response<any, Record<string, any>, number>;
    router: string;
    routes: any;
    search: IRouterMatcher<Express, any>;
    settings: any;
    stack: any[];
    startService: ((opts) => Promise<Server>);
    subscribe: IRouterMatcher<Express, any>;
    trace: IRouterMatcher<Express, any>;
    unlink: IRouterMatcher<Express, any>;
    unlock: IRouterMatcher<Express, any>;
    unsubscribe: IRouterMatcher<Express, any>;
    use: ApplicationRequestHandler<Express>;
    addListener(event, listener): this;
    defaultConfiguration(): void;
    disable(setting): this;
    disabled(setting): boolean;
    emit(event, ...args): boolean;
    enable(setting): this;
    enabled(setting): boolean;
    engine(ext, fn): this;
    eventNames(): (string | symbol)[];
    getMaxListeners(): number;
    init(): void;
    listen(port, hostname, backlog, callback?): Server;
    listen(port, hostname, callback?): Server;
    listen(port, callback?): Server;
    listen(callback?): Server;
    listen(path, callback?): Server;
    listen(handle, listeningListener?): Server;
    listenerCount(type): number;
    listeners(event): Function[];
    off(event, listener): this;
    once(event, listener): this;
    param(name, handler): this;
    param(callback): this;
    path(): string;
    prependListener(event, listener): this;
    prependOnceListener(event, listener): this;
    rawListeners(event): Function[];
    removeAllListeners(event?): this;
    removeListener(event, listener): this;
    render(name, options?, callback?): void;
    render(name, callback): void;
    route<T>(prefix): IRoute<T>;
    route(prefix): IRoute<string>;
    set(setting, val): this;
    setMaxListeners(n): this;
}

• _router: any

  Used to get all registered routes in Express Application

• all: IRouterMatcher<Express, "all">

  Special-cased "all" method, applying the given route path, middleware, and callback to every HTTP method.

• checkout: IRouterMatcher<Express, any>

• connect: IRouterMatcher<Express, any>

• copy: IRouterMatcher<Express, any>

• delete: IRouterMatcher<Express, "delete">

• get: ((name) => any) & IRouterMatcher<Express, any>

• head: IRouterMatcher<Express, "head">

• link: IRouterMatcher<Express, any>

• locals: Record<string, any> & Locals

• lock: IRouterMatcher<Express, any>

• m-search: IRouterMatcher<Express, any>

• map: any

• merge: IRouterMatcher<Express, any>

• mkactivity: IRouterMatcher<Express, any>

• mkcol: IRouterMatcher<Express, any>

• mountpath: string | string[]

  The app.mountpath property contains one or more path patterns on which a sub-app was mounted.

• move: IRouterMatcher<Express, any>

• notify: IRouterMatcher<Express, any>

• on: ((event, callback) => this)

  The mount event is fired on a sub-app, when it is mounted on a parent app. The parent app is passed to the callback function.

  NOTE: Sub-apps will:

  • Not inherit the value of settings that have a default value. You must set the value in the sub-app.
  • Inherit the value of settings with no default value.
  • • (event, callback): this

    • The mount event is fired on a sub-app, when it is mounted on a parent app. The parent app is passed to the callback function.

      NOTE: Sub-apps will:

      • Not inherit the value of settings that have a default value. You must set the value in the sub-app.
      • Inherit the value of settings with no default value.

      Parameters

      • event: string

      • callback: ((parent) => void)

        • • (parent): void

          • Parameters

            • parent: Application<Record<string, any>>

            Returns void

      Returns this

• options: IRouterMatcher<Express, "options">

• patch: IRouterMatcher<Express, "patch">

• post: IRouterMatcher<Express, "post">

• propfind: IRouterMatcher<Express, any>

• proppatch: IRouterMatcher<Express, any>

• purge: IRouterMatcher<Express, any>

• put: IRouterMatcher<Express, "put">

• report: IRouterMatcher<Express, any>

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

• resource: any

• response: Response<any, Record<string, any>, number>

• router: string

• routes: any

  The app.routes object houses all of the routes defined mapped by the associated HTTP verb. This object may be used for introspection capabilities, for example Express uses this internally not only for routing but to provide default OPTIONS behaviour unless app.options() is used. Your application or framework may also remove routes by simply by removing them from this object.

• search: IRouterMatcher<Express, any>

• settings: any

• stack: any[]

  Stack of configured routes

• startService: ((opts) => Promise<Server>)

  • • (opts): Promise<Server>

    • Parameters

      • opts: ServiceOpts | ServiceOptsWithOAuth

      Returns Promise<Server>

• subscribe: IRouterMatcher<Express, any>

• trace: IRouterMatcher<Express, any>

• unlink: IRouterMatcher<Express, any>

• unlock: IRouterMatcher<Express, any>

• unsubscribe: IRouterMatcher<Express, any>

• use: ApplicationRequestHandler<Express>

• addListener:function

  • addListener(event, listener): this

  • Parameters

    • event: string | symbol

    • listener: ((...args) => void)

      • • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

• defaultConfiguration:function

  • defaultConfiguration(): void

  • Initialize application configuration.

    Returns void

• disable:function

  • disable(setting): this

  • Disable setting.

    Parameters

    • setting: string

    Returns this

• disabled:function

  • disabled(setting): boolean

  • Check if setting is disabled.

    app.disabled('foo') // => true

    app.enable('foo') app.disabled('foo') // => false

    Parameters

    • setting: string

    Returns boolean

• emit:function

  • emit(event, ...args): boolean

  • Parameters

    • event: string | symbol

    • Rest ...args: any[]

    Returns boolean

• enable:function

  • enable(setting): this

  • Enable setting.

    Parameters

    • setting: string

    Returns this

• enabled:function

  • enabled(setting): boolean

  • Check if setting is enabled (truthy).

    app.enabled('foo') // => false

    app.enable('foo') app.enabled('foo') // => true

    Parameters

    • setting: string

    Returns boolean

• engine:function

  • engine(ext, fn): this

  • Register the given template engine callback fn as ext.

    By default will require() the engine based on the file extension. For example if you try to render a "foo.jade" file Express will invoke the following internally:

    app.engine('jade', require('jade').__express);
    Copy

    For engines that do not provide .__express out of the box, or if you wish to "map" a different extension to the template engine you may use this method. For example mapping the EJS template engine to ".html" files:

    app.engine('html', require('ejs').renderFile);
    Copy

    In this case EJS provides a .renderFile() method with the same signature that Express expects: (path, options, callback), though note that it aliases this method as ejs.__express internally so if you're using ".ejs" extensions you dont need to do anything.

    Some template engines do not follow this convention, the Consolidate.js library was created to map all of node's popular template engines to follow this convention, thus allowing them to work seamlessly within Express.

    Parameters

    • ext: string

    • fn: ((path, options, callback) => void)

      • • (path, options, callback): void

        • Parameters

          • path: string

          • options: object

          • callback: ((e, rendered?) => void)

            • • (e, rendered?): void

              • Parameters

                • e: any

                • Optional rendered: string

                Returns void

          Returns void

    Returns this

• eventNames:function

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

• getMaxListeners:function

  • getMaxListeners(): number

  • Returns number

• init:function

  • init(): void

  • Initialize the server.

    • setup default configuration
    • setup default middleware
    • setup route reflection methods

    Returns void

• listen:function

  • listen(port, hostname, backlog, callback?): Server

  • Listen for connections.

    A node http.Server is returned, with this application (which is a Function) as its callback. If you wish to create both an HTTP and HTTPS server you may do so with the "http" and "https" modules as shown here:

    var http = require('http') , https = require('https') , express = require('express') , app = express();

    http.createServer(app).listen(80); https.createServer({ ... }, app).listen(443);

    Parameters

    • port: number

    • hostname: string

    • backlog: number

    • Optional callback: (() => void)

      • • (): void

        • Returns void

    Returns Server
  • listen(port, hostname, callback?): Server

  • Parameters

    • port: number

    • hostname: string

    • Optional callback: (() => void)

      • • (): void

        • Returns void

    Returns Server

  • listen(port, callback?): Server

  • Parameters

    • port: number

    • Optional callback: (() => void)

      • • (): void

        • Returns void

    Returns Server

  • listen(callback?): Server

  • Parameters

    • Optional callback: (() => void)

      • • (): void

        • Returns void

    Returns Server

  • listen(path, callback?): Server

  • Parameters

    • path: string

    • Optional callback: (() => void)

      • • (): void

        • Returns void

    Returns Server

  • listen(handle, listeningListener?): Server

  • Parameters

    • handle: any

    • Optional listeningListener: (() => void)

      • • (): void

        • Returns void

    Returns Server

• listenerCount:function

  • listenerCount(type): number

  • Parameters

    • type: string | symbol

    Returns number

• listeners:function

  • listeners(event): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

• off:function

  • off(event, listener): this

  • Parameters

    • event: string | symbol

    • listener: ((...args) => void)

      • • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

• once:function

  • once(event, listener): this

  • Parameters

    • event: string | symbol

    • listener: ((...args) => void)

      • • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

• param:function

  • param(name, handler): this

  • Parameters

    • name: string | string[]

    • handler: RequestParamHandler

    Returns this

  • param(callback): this

  • Alternatively, you can pass only a callback, in which case you have the opportunity to alter the app.param()

    Parameters

    • callback: ((name, matcher) => RequestParamHandler)

      • • (name, matcher): RequestParamHandler

        • Parameters

          • name: string

          • matcher: RegExp

          Returns RequestParamHandler

    Returns this

    Deprecated

    since version 4.11

• path:function

  • path(): string

  • Return the app's absolute pathname based on the parent(s) that have mounted it.

    For example if the application was mounted as "/admin", which itself was mounted as "/blog" then the return value would be "/blog/admin".

    Returns string

• prependListener:function

  • prependListener(event, listener): this

  • Parameters

    • event: string | symbol

    • listener: ((...args) => void)

      • • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

• prependOnceListener:function

  • prependOnceListener(event, listener): this

  • Parameters

    • event: string | symbol

    • listener: ((...args) => void)

      • • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

• rawListeners:function

  • rawListeners(event): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

• removeAllListeners:function

  • removeAllListeners(event?): this

  • Parameters

    • Optional event: string | symbol

    Returns this

• removeListener:function

  • removeListener(event, listener): this

  • Parameters

    • event: string | symbol

    • listener: ((...args) => void)

      • • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

• render:function

  • render(name, options?, callback?): void

  • Render the given view name name with options and a callback accepting an error and the rendered template string.

    Example:

    app.render('email', { name: 'Tobi' }, function(err, html){ // ... })

    Parameters

    • name: string

    • Optional options: object

    • Optional callback: ((err, html) => void)

      • • (err, html): void

        • Parameters

          • err: Error

          • html: string

          Returns void

    Returns void
  • render(name, callback): void

  • Parameters

    • name: string

    • callback: ((err, html) => void)

      • • (err, html): void

        • Parameters

          • err: Error

          • html: string

          Returns void

    Returns void

• route:function

  • route<T>(prefix): IRoute<T>

  • Type Parameters

    • T extends string

    Parameters

    • prefix: T

    Returns IRoute<T>

  • route(prefix): IRoute<string>

  • Parameters

    • prefix: PathParams

    Returns IRoute<string>

• set:function

  • set(setting, val): this

  • Assign setting to val, or return setting's value.

    app.set('foo', 'bar'); app.get('foo'); // => "bar" app.set('foo', ['bar', 'baz']); app.get('foo'); // => ["bar", "baz"]

    Mounted servers inherit their parent server's settings.

    Parameters

    • setting: string

    • val: any

    Returns this

• setMaxListeners:function

  • setMaxListeners(n): this

  • Parameters

    • n: number

    Returns this