[//]: # ( ns__file unit: standard, comp: README.md )

[//]: # ( ns__custom_start beginning )

[//]: # ( ns__custom_end beginning )

[//]: # ( ns__start_section intro )

[//]: # ( ns__custom_start description )
A function that replaces keys from dynamically specified objects within the values for a raw object.

!dynamapping

[//]: # ( ns__custom_end description )

[//]: # ( ns__custom_start afterDescription )

[//]: # ( ns__custom_end afterDescription )

[//]: # ( ns__custom_start badges )

[//]: # ( ns__start_section usageSection )




[//]: # ( ns__custom_end badges )

[//]: # ( ns__end_section intro )

[//]: # ( ns__start_section api )

[//]: # ( ns__custom_start APIIntro )

* :clipboard: Why
* :white_check_mark: What
* :bulb: How

:clipboard: Why

You may want to update objects retrieved from a static source (such as a file) using a session with dynamically set values. It's a pain to set up the logic of mapping through session data and calling replace.

:white_check_mark: What

A single function that you can pass in a flat object to and replace strings in the object values with your session values.

Your replacements (the values in your session object) can include a string, a number, a boolean, or a JSON-stringified object. dynomapping will determine the intended type as follows:
1. A boolean or a string of a boolean will be converted to a boolean unless it is contained in a larger string
2. Similar treatment is done for valid number strings or JSON stringifications.

:bulb: How

Include the function:
``
npm i dynamapping
`

You can insert into the values for keys of a given object a string in the form __session.__. Then, dynamically set the session object to have a value that will be replaced when you call dynamapping. For instance,
`
const dynamapping = require('dynamapping')
const session = {
userName: 'Filbert'
}
let obj = {
hello: 'hi __session.userName__'
};
obj = dynamapping( obj, session, {})

// obj will be set to { hello: 'hi Filbert' }
`

Notes:

1. object currently needs to be of depth 1 (no recursion is currently implemented.)
2. You can currently use one of two mappings: session and answer. (The session object is so named to be generic. The answer object can be useful for an interactive session, for instance using inquirer).
3. if you set a value in session (or answers) to 'true' or 'false' then dynamapping will assume that you intended the boolean value and will return the boolean true or false respectively. For instance:
`
const obj = {
testCase: '__session.isTrue__'
};
const sessionObj = {
userName: 'Filbert',
isTrue: 'false'
}
obj replaceGlobalValuesInObject(obj, sessionObj, ansObj)
// obj = {testCase: false} rather than {testCase: 'false'}
`
But if it's embedded within a larger string, it will remain a string e.g. 'it is __session.isTrue__ now!`
4.Numbers are treated the same way. If you have a key set to a single number, then it will remain a number.

[//]: # ( ns__custom_end APIIntro )

[//]: # ( ns__custom_start constantsIntro )
[//]: # ( ns__custom_end constantsIntro )

[//]: # ( ns__start_section types )

[//]: # ( ns__end_section types )

[//]: # ( ns__end_section api )