Store configuration for Node.JS module for HTTPS RESTful Resume API Client
Credentials and Configuration object for Resume API. They can be overriden by prioriy: credentials file (credentials JSON file) > process.env.* > default API values. The example of credentials file locate at ../credentials.template.json.
Kind: inner typedef of config
Summary: Credentials object for Resume API, Automatically set by Resume Config.
Properties
| Name | Type | Description |
|---|---|---|
| [CREDENTIALS_FILE] | string |
path to credentials JSON file. If file is not found, ResumeCredentials will not override config by credentials file (not raise error, only show warning). overriding step: process.env.CREDENTIALS_FILE > "credentials.json" by default. |
| [host] | string |
full host path to Resume API overriding step: "host" in credentials files > process.env.REST_HOST > "https://resume.sati.co.th" (default). |
| [username] | string |
username for Resume API overriding step: "username" in credentials files > process.env.REST_USER. |
| [password] | string |
password for Resume API overriding step: "password" in credentials files > process.env.REST_PW. |
| [section_id_default] | string | int |
default Section ID, information for Resume API overriding step: "section_id_default" in credentials files > process.env.REST_DEFAULT_SECTION > 0. |
| [lang_json] | string |
path to array of languages hint-storing JSON. If file is not found, ResumeCredentials.lang property will skip to next overriding step (not raise error, only show warning). Please see example in ../public/lang.json overriding step: process.env.LANG_JSON > "public/lang.json" (default), respectively. |
| [lang] | Array.<string> |
language hints must be BCP-47 language code in string type or array of string type ordered by highest priority to suggest the speech-to-text API - the default is located in ./public/lang.json . See more detail of BCP-47 overriding step: "section_id_default" in credentials files > read JSON file at this.lang_json path > JSON.parse(process.env.REST_LANG) > Resume API default config. |
© 2021 - copyright by Tanapat Kahabodeekanokkul - the founder of RESUME.