aljaz/pear-docs
1
0
Fork 0
mirror of https://github.com/aljazceru/pear-docs.git synced 2025-12-17 14:34:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update how development mode affects Pear config API (#177)

Browse Source
This commit is contained in:
Sean Zellmer
2025-03-20 13:38:09 -05:00
committed by GitHub
parent 5800a7031f
commit 08caadb392
1 changed files with 3 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
reference/pear/api.md
View File

@@ -23,14 +23,11 @@ Contains application configuration data.
### `Pear.config.key <Object|null>` ### `Pear.config.key <Object|null>`
The application key, `null` in development mode.
The `config.key` object holds both Hexadecimal and Z-Base-32 encodings of the key, and is of the form `{ z32: <String>, hex: <String> }`, The `config.key` object holds both Hexadecimal and Z-Base-32 encodings of the key, and is of the form `{ z32: <String>, hex: <String> }`,
### `Pear.config.dev <Boolean>` ### `Pear.config.dev <Boolean>`
Application is local (loaded from disk). Whether the application is in development mode.
Equivalent to `pear.config.key === null`.
### `Pear.config.tier <String>` ### `Pear.config.tier <String>`
@@ -50,7 +47,7 @@ Application entry file
### `Pear.config.channel <String|null>` ### `Pear.config.channel <String|null>`
Application release/staging channel, `null` in development mode. Application release/staging channel.
### `Pear.config.options <Object>` ### `Pear.config.options <Object>`
@@ -145,7 +142,7 @@ The returned `Promise` will resolve once the checkpoint has been successfully st
### `Pear.config.release <Integer>` ### `Pear.config.release <Integer>`
Application release sequence integer, `null` in development mode. Application release sequence integer.
### `Pear.config.flags <Object>` ### `Pear.config.flags <Object>`