https://github.com/dan503/defaultto
Easily set defaults to an object at multiple depths
https://github.com/dan503/defaultto
Last synced: 4 months ago
JSON representation
Easily set defaults to an object at multiple depths
- Host: GitHub
- URL: https://github.com/dan503/defaultto
- Owner: Dan503
- License: mit
- Created: 2016-11-08T07:50:57.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-11-20T00:50:06.000Z (over 9 years ago)
- Last Synced: 2025-08-29T22:00:40.411Z (9 months ago)
- Language: HTML
- Size: 15.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# defaultTo
Easily set defaults to an object at multiple depths
`````
npm install default-to --save
`````
This function is essentially the opposite of my [replaceValues](https://www.npmjs.com/package/replace-values) function.
##JS Usage
This is how you would use it in a javascript file
###Single level
`````js
var defaultTo = require('default-to');
var example = { one: 1 };
var defaultToExample = defaultTo(example, {
one: 'one',
two: 'two',
three: 'three'
});
`````
In this case `example` would now equal this:
`````js
{
one: 1,
two: 'two',
three: 'three'
}
`````
###Nested
The function can also assign defaults to nested objects
`````js
var defaultTo = require('default-to');
var example = {
one: {
number: 10,
}
};
var defaultToExample = defaultTo(example, {
one: {
number: 1,
string: 'one'
},
two: {
number: 2,
string: 'two'
}
});
`````
In this case `defaultToExample` would now equal this:
`````js
{
one: {
number: 10,
string: 'one'
},
two: {
number: 2,
string: 'two'
}
}
`````
###Flat
You can also just use it on flat variables
`````js
var example = defaultTo(variable, 'default value');
`````
in the above code snippet, if `variable` is defined, `example` would equal `variable` else it will equal `'default value'`. It is the equivelant of writing this:
````js
var example = typeof variable !== 'undefined' ? variable : 'default value';
````
##Pug and Jade usage
This npm package also comes with [Pug and Jade](https://pugjs.org/api/getting-started.html) versions of the function. To use the function in your pug/jade templates add this to the top of your base pug/jade file:
`````jade
include ../../node_modules/default-to/defaultTo
`````
Make sure the path is correct, it will be different depending on your folder structure. It is a relative path from the file it is being included in. Also, note that there is no file extension in the example.
After including that line, you can use it in the same ways that I have used it above except you need to make sure you nest the js inside a js block. This is especially usefull for mixins
``````jade
mixin module(spec)
-
spec = defaultTo(spec, {
classes: {
outer: 'outer',
inner: 'inner'
},
})
.module(class=spec.classes.outer)
.module__inner(class=spec.classes.inner)
``````
##More functionality
These features are only available in the js version and they assume you are able to use ES6 syntax.
###applyDefaults
This is a small variation on the defaultTo function that overides the origional variable without having to reference it first.
`````js
import { applyDefaults } from 'default-to';
var example = {
two: {
a: 'zzz'
}
};
applyDefaults(example, {
one: 1,
two : {
a: 'aaa',
b: 'bbb'
},
three: 3
});
//example now equals { one: 1, two: {a:'zzz', b: 'bbb' }, three: 3}
`````
**WARNING!!!** in order to use this version of defaultTo, `example` **must** already be defined as something.
In the standard defaultTo function you can get away with the variable being undefined when parsing it into the function but `applyDefaults` needs to at least have an empty object to be parsed into the function for it to work.
You can get around this by using it like this inside a function when es6 syntax is available to you.
`````````js
function funcName(variable = {}){
applyDefaults(variable, {
one: 'one',
two: 'two',
three: 'three'
});
}
`````````
##Breaking changes
**v2.0.0:** The replaceValues function has been moved from the default-to package into it's own [seperate npm package](https://www.npmjs.com/package/replace-values). Also the replaceValues function syntax is more reminiscent of the defaultTo function syntax in how it is used now rather than the applyDefaults syntax.
##Developers
When publishing, use the [babel-it](https://github.com/IonicaBizau/babel-it) npm plugin to to convert the js files into es5 syntax for better environment support.