- Source:
Classes
Type Definitions
Auth
Type:
- object
Properties:
Name | Type | Description |
---|---|---|
userKey |
string | (Optional) The key from |
passKey |
string | (Optional) The key from |
isRequired |
string | (Optional) If |
- Source:
Badge
Badge Object, validated against serviceDataSchema
Type:
- object
Properties:
Name | Type | Description |
---|---|---|
isError |
boolean | (Optional) |
label |
string | (Optional) |
message |
string | number | |
color |
string | (Optional) |
link |
Array.<string> | (Optional) |
- Source:
DefaultBadgeData
Default badge properties, validated against defaultBadgeDataSchema
Type:
- object
Properties:
Name | Type | Description |
---|---|---|
label |
string | (Optional) |
color |
string | (Optional) |
labelColor |
string | (Optional) |
namedLogo |
string | (Optional) |
- Source:
Example
Type:
- object
Properties:
Name | Type | Description |
---|---|---|
title |
string | Descriptive text that will be shown next to the badge. The default is to use the service class name, which probably is not what you want. |
namedParams |
object | An object containing the values of named parameters to substitute into the compiled route pattern. |
queryParams |
object | An object containing query parameters to include in the
example URLs. For alphanumeric query parameters, specify a string value.
For boolean query parameters, specify |
pattern |
string | The route pattern to compile. Defaults to |
staticPreview |
object | A rendered badge of the sort returned by |
keywords |
Array.<string> | Additional keywords, other than words in the title. This helps users locate relevant badges. |
documentation |
string | An HTML string that is included in the badge popup. |
- Source:
Route
Type:
- object
Properties:
Name | Type | Description |
---|---|---|
base |
string | (Optional) The base path of the routes for this service. This is used as a prefix. |
pattern |
string | A path-to-regexp pattern defining the route pattern and param names See https://www.npmjs.com/package/path-to-regexp |
format |
RegExp | Deprecated: Regular expression to use for routes for this service's badges
Use |
capture |
Array.<string> | Deprecated: Array of names for the capture groups in the regular
expression. The handler will be passed an object containing
the matches.
Use |
queryParamSchema |
Joi.object | (Optional) A Joi schema ( |
- Source: