Methods
extract(options, manifestopt) → {Promise}
- Source:
- See:
Extract and process the destiny manifest.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
options |
ExtractOptions | options for the extract process. | |
manifest |
object |
<optional> |
an already downloaded manifest description from https://www.bungie.net/Platform/Destiny/Manifest/ if not provided the manifest will be downloaded. |
Returns:
- a promise for the extraction process.
- Type
- Promise
Type Definitions
ExtractOptions
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
processor |
processor | the processor to run against manifest content. | ||
options.langs |
Array.<string> |
<optional> |
['en', 'fr', 'es', 'de', 'it', 'ja', 'pt-br']
|
a list of languages to download content from the manifest for. |
options.path |
string |
<optional> |
'./manifest-content'
|
where to download the databases to. |
apiKey |
string |
<optional> |
your applications api key for the bungie API, used if a manifest is not provided. |
Type:
- object
processor(lang, entry)
Handler for manifest data read from the sqlite database.
Parameters:
| Name | Type | Description |
|---|---|---|
lang |
string | the language code of the content in the entry. |
entry |
ManifestEntry | a single entry from the manifest database. |