@cursorsdottsx/f v2.1.0
| a | b | c | d | e | f | g | h | i | j | k | l | m | n | o | p | q | r | s | t | u | v | w | x | y | z |
F is for Fill
@cursorsdottsx/f
A small ezpz module to fill and populate your objects when needed to preserve memory.
If you have thicc af objects that you only use sometimes, this is a good use case.
import "@cursorsdottsx/f";
function generateMyThiccObject() {
return { ... }; // a lotta shit
}
const myThiccObject = {
data: new Fill(generateMyThiccObject),
};
const filledThiccObject = Fill.fill(myThiccObject);
// or if you want it to fill the reference instead
Fill.populate(myThiccObject);Heavily inspired by mongoose's populate method, this is a robust and versatile library to handle fillings, and of course thicc objects.
Install and use right now or else
npm install @cursorsdottsx/fyarn add @cursorsdottsx/fOnce you import the library, it will export a Fill object that you can use.
It's API is very simple.
Documentation
new Fill(blueprint, ...arguments)
blueprint– Can be a function or class. This will replace the property with the return value of the function/class instance.arguments– Arguments to pass to the function or class.
Creates a new filler for your objects.
Fill.prototype.blueprint
The blueprint.
Fill.prototype.args
The arguments for the blueprint.
Fill.prototype.init()
Executes the blueprint with the arguments provided.
Fill.fill(object)
object– Object to fill.
Fills an object and replaces all Fill instances.
Fill.unfill(object)
object– Object to restore.
Restores a filled object back to its original state.
Fill.populate(object)
object– Object to fill.
Replaces the object's properties (in contrast to fill that returns a newly constructed object).
Fill.unpopulate(object)
object– Object to restore.
Restores the object's properties (in constrast to unfill that returns a newly reconstructed object).