Namespace for BDv2.
- Source:
- See:
Methods
(static) validateConfig(config)
Validates a BDv2 config object.
Parameters:
| Name | Type | Description |
|---|---|---|
config |
Object | The config object to validate. |
- Source:
Throws:
Will throw an error if any of the required properties are missing.
Type Definitions
Author
Object representing a theme author.
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
name |
string | The author's name. |
|
discord_id |
string | The author's Discord ID. |
|
url |
string |
<optional> |
The author's website. |
github_username |
string |
<optional> |
The author's GitHub username. |
twitter_username |
string |
<optional> |
The author's Twitter username. |
- Source:
Config
Object representing a theme's configuration.
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
info |
BDv2~Info | The theme's info. |
|
main |
string | The main theme file. |
|
configSchemes |
Array.<Object> |
<optional> |
The theme's settings. |
defaultConfig |
Array.<Object> |
<optional> |
The default settings. |
- Source:
Info
Object representing a theme's info.
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
type |
string | The theme's type. |
|
description |
string | The theme's description. |
|
version |
string | number | The theme's version. |
|
icon |
string | The theme's icon in base64. |
|
authors |
Array.<(BDv2~Author|string)> | The theme's authors. |
|
source |
string |
<optional> |
The theme's source URL. |
website |
string |
<optional> |
The theme's website URL. |
- Source: