Class: Waibu

Constructor

new Waibu()

Source: index.js, line 53

Members

config :Waibu.TConfig

Configuration object. To override the default configuration, you can create data/config/waibu.json

Type:

Waibu.TConfig

Source: index.js, line 78

escapeChars :Waibu.TEscapeChars

Type:

Waibu.TEscapeChars

Source: index.js, line 64

hookTypes :Array.<string>

Type:

Array.<string>

Default Value: ['onRequest', 'onResponse', 'preParsing', 'preValidation', 'preHandler', 'preSerialization', 'onSend', 'onTimeout', 'onError']
Source: index.js, line 58

qs :Object

Query string parser and stringifier. It is a wrapper of query-string package.

Type:

Object

Properties

Name	Type	Description
`qs.parse`	function	Query string parser
`qs.parseUrl`	function	Query string url parser
`qs.stringify`	function	Query string stringifier
`qs.stringifyUrl`	function	Query string url stringifier

Source: index.js, line 89

Methods

(async) _handleAppHook() → {Promise.<void>}

Handle app hooks. It will run hooks for each web app and main app.

Source: index.js, line 769

Returns:

Type:: Promise.<void>

(async) _handleError() → {Promise.<void>}

Route error handler.

Source: index.js, line 700

Returns:

Type:: Promise.<void>

(async) _handleFavicon() → {Promise.<void>}

Create route for '/favicon.:ext'

Location of favicon file can be found in:

main plugin's file; if not found, then
site attachment; if not found, then
static dir of theme; if not found, then
default plugin's file

Source: index.js, line 636

Returns:

Type:: Promise.<void>

(async) _handleForward() → {Promise.<void>}

Handle forward. It will decorate reply object with forwardTo method.

Source: index.js, line 739

Returns:

Type:: Promise.<void>

(async) _handleHome() → {Promise.<void>}

Create route for '/' to redirect to home path.

Source: index.js, line 666

Returns:

Type:: Promise.<void>

(async) _handleNotFound() → {Promise.<void>}

Route not found handler.

Source: index.js, line 686

Returns:

Type:: Promise.<void>

(async) _handleRedirect(options) → {Promise.<void>}

Handle redirect. It will decorate reply object with redirectTo method.

Parameters:

Name	Type	Description
`options`	object

Source: index.js, line 725

Returns:

Type:: Promise.<void>

(async) _handleRobotsTxt() → {Promise.<void>}

Create route for '/robots.txt'.

Location of robots.txt file can be found in:

main plugin's file; if not found, then
site attachment; if not found, then
default plugin's file

Source: index.js, line 605

Returns:

Type:: Promise.<void>

_printRoutes() → {void}

Print all registered routes.

Source: index.js, line 788

Returns:

Type:: void

(async) _runWebApps() → {Promise.<void>}

Run web applications.

Source: index.js, line 812

Returns:

Type:: Promise.<void>

base64JsonDecode(data) → {Object}

Decode base64 encoded json string

Parameters:

Name	Type	Description
`data`	string	Base64 encoded JSON string

Source: index.js, line 541

Returns:

Decoded JSON object

Type:: Object

base64JsonEncode(data) → {string}

Encode JSON object to base64 string

Parameters:

Name	Type	Description
`data`	Object	JSON object to encode

Source: index.js, line 552

Returns:

Base64 encoded JSON string

Type:: string

escape(text) → {string}

Escape text

Parameters:

Name	Type	Description
`text`	string

Source: index.js, line 209

Returns:

Type:: string

(async) exit()

Exit handler

Source: index.js, line 170

(async) fetch(url, optsopt, extraopt) → {Object}

Fetch something from url. A wrapper of bajo-extra's fetchUrl which support bajo's ns based url.

Parameters:

Name	Type	Attributes	Default	Description
`url`	string			Also support ns based url
`opts`	Object	<optional>	{}	node's fetch options
`extra`	Object	<optional>	{}	See bajo-extra

Source: index.js, line 233

Returns:

Type:: Object

findRoute(name) → {Object}

Find route by route name

Parameters:

Name	Type	Description
`name`	string	ns based route name

Source: index.js, line 181

Returns:

Route object

Type:: Object

getHostname(req) → {string}

Get hostname from fastify's request object

Parameters:

Name	Type	Description
`req`	Object

Source: index.js, line 284

Returns:

Type:: string

getIp(req) → {string}

Get visitor IP from fastify's request object

Parameters:

Name	Type	Description
`req`	Object	request object

Source: index.js, line 256

Returns:

Type:: string

getOrigin(req) → {string}

Get origin from fastify's request object

Parameters:

Name	Type	Description
`req`	Object

Source: index.js, line 270

Returns:

Type:: string

getPluginByPrefix(prefix, nsOnly) → {Object}

Get plugin by prefix

Parameters:

Name	Type	Description
`prefix`	string
`nsOnly`	boolean	Set `true` to return plugin's namespace only

Source: index.js, line 296

Returns:

Type:: Object

getPluginPrefix(name, webAppopt) → {string}

Get plugin's prefix by name

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			Plugin's name
`webApp`	string	<optional>	waibuMpa	Web app to use

Source: index.js, line 313

Returns:

Type:: string

getRoutes(groupedopt, liteopt) → {Array}

Get all available routes

Parameters:

Name	Type	Attributes	Default	Description
`grouped`	boolean	<optional>	false	Returns as groups of urls and methods
`lite`	*	<optional>	false	Retuns only urls and methods

Source: index.js, line 331

Returns:

Type:: Array

getUploadedFiles(reqId, fileUrlopt, returnDir) → {Object|Array}

Get uploaded files by request ID

Parameters:

Name	Type	Attributes	Default	Description
`reqId`	string			Request ID
`fileUrl`	boolean	<optional>	false	If `true`, files returned as file url format (`file:///...`)
`returnDir`	*			If `true`, also return its directory

Source: index.js, line 352

Returns:

Returns object if returnDir is true, array of files otherwise

Type:: Object | Array

(async) init()

Initialize plugin

Source: index.js, line 108

isIntlPath(ns) → {boolean}

Is namespace's path contains language detector token?

Parameters:

Name	Type	Description
`ns`	string	Plugin name

Source: index.js, line 369

Returns:

Type:: boolean

parseFilter(req) → {Object}

Parse filter found from Fastify's request based on keys set in config object

Parameters:

Name	Type	Description
`req`	Object	Request object

Source: index.js, line 381

Returns:

Type:: Object

routeDir(ns, baseNsopt) → {string}

Get route directory by plugin's name

Parameters:

Name	Type	Attributes	Description
`ns`	*		Namespace
`baseNs`	*	<optional>	Base namespace. If not provided, defaults to scope's ns

Source: index.js, line 398

Returns:

Type:: string

routePath(name, optionsopt) → {string}

Get route path by route's name:

If it is a mailto: or tel: url, it returns as is
If it starts with :/, name will be prefixed with its ns automatically
If it is a ns based name, it will be parsed first

Parameters:

Name Type Attributes Default Description

name string

options

Object

{}

Options object

Properties

Name	Type	Attributes	Default	Description
`ns`	string	<optional>	waibu	Base namespace
`guessHost`	boolean	<optional>		If true, guest host if host is not set
`query`	Object	<optional>	{}	Query string's object. If provided, it will be added to returned value
`params`	Object	<optional>	{}	Parameter object. If provided, it will be merged to returned value

Source: index.js, line 425

Returns:

Type:: string

(async) start()

Start plugin

Source: index.js, line 130

unescape(text) → {string}

Unescape text using TEscapeChars rules

Parameters:

Name	Type	Description
`text`	string	Text to unescape

Source: index.js, line 494

Returns:

Type:: string

unescapeBlock(content, start, end, startReplacer, endReplacer) → {string}

Recursively unescape block of texts

Parameters:

Name	Type	Description
`content`	string	Source content
`start`	string	Block's start
`end`	string	Block's end
`startReplacer`	string	Token to use as block's start replacer
`endReplacer`	string	Token to use as block's end replacer

Source: index.js, line 476

Returns:

Type:: string

Type Definitions

TConfig

Type:

Object

Properties

Name Type Attributes Default Description

home

Object

Home configuration

server

Object

Server configuration

Properties

Name	Type	Attributes	Default	Description
`host`	string	<optional>	'127.0.0.1'	Server host
`port`	number	<optional>	17845	Server port

factory

Object

Factory configuration. @see https://fastify.dev/docs/latest/Reference/Server/#factory

intl

Object

Internationalization configuration

Properties

Name	Type	Attributes	Default	Description
`detectors`	Array.<string>	<optional>	['qs']	Language detectors

log

Object

Logging configuration

Properties

Name	Type	Attributes	Default	Description
`disable`	Array.<string>	<optional>	[]	Disabled loggers. Available values: 'request' & 'response'
`defer`	boolean	<optional>	false	Defer logging

prefixVirtual

string

Prefix for virtual routes

favicon

boolean | string

true

Favicon configuration

robotsTxt

boolean

true

Set to 'false' to disable robots.txt route

qsKey

Object

Query string key configuration

Properties

Name	Type	Attributes	Default	Description
`bbox`	string	<optional>	'bbox'	Bounding box key
`bboxLatField`	string	<optional>	'bboxLatField'	Bounding box latitude field key
`bboxLngField`	string	<optional>	'bboxLngField'	Bounding box longitude field key
`query`	string	<optional>	'query'	Query key
`search`	string	<optional>	'search'	Search key
`skip`	string	<optional>	'skip'	Skip key
`page`	string	<optional>	'page'	Page key
`limit`	string	<optional>	'limit'	Limit key
`sort`	string	<optional>	'sort'	Sort key
`fields`	string	<optional>	'fields'	Fields key
`lang`	string	<optional>	'lang'	Language key

paramsCharMap

Object

{}

Parameters character map

route

Object

{}

Route configuration

Properties

Name	Type	Attributes	Default	Description
`print`	boolean	<optional>	true	Print route information
`disabled`	Array.<string>	<optional>	[]	Disabled routes

pageTitleFormat

string

'%s : %s'

Page title format

siteInfo

Object

{}

Site information

Properties

Name	Type	Attributes	Default	Description
`title`	string	<optional>	'My Website'	Site title
`orgName`	string	<optional>	'My Organization'	Organization name

cors

Object

{}

CORS configuration

compress

Object

{}

Compression configuration

helmet

Object

{}

Helmet configuration

rateLimit

Object

{}

Rate limit configuration

multipart

Object

{}

Multipart configuration

exposeError

boolean

false

Expose error configuration

underPressure

boolean

false

Under pressure configuration

forwardOpts

Object

{}

Forward options configuration

Properties

Name	Type	Attributes	Default	Description
`disableRequestLogging`	boolean	<optional>	true	Disable request logging for forward requests
`undici`	Object	<optional>	{}	Undici configuration for forward requests

Source: lib/config.js, line 1

TEscapeChars

Type:

Object

Properties

Name	Type	Default
`<`	string	<
`>`	string	>
`"`	string	"
`'`	string	'

Source: index.js, line 13