Skip to content

jvopinho/ObjRef

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 

Repository files navigation

ObjRef

Objref, a simple object manager using reference.


Starting

    const ObjRef = require("./src/ObjRef.js")

    const obj = new ObjRef(/* Object */)
Parameter Type Descrirption
obj object Base object
separator string Separator for dividing to reference properties Note: Default separator is "/"

Preparing

    const ObjRef = require("./src/ObjRef.js")
    const obj_base = {
        users: {
            "001": {
                name: "João Oliveira",
                nickname: "JVOPINHO",
                id: "001"
            },
            "002": null,
            "003": {
                name: "Luiz",
                nickname: "luizdodibre",
                id: "003"
            },
            "004": {
                name: "Sayran",
                nickname: "Polaroo",
                id: "004"
            }
        }
    }
    const obj = new ObjRef(obj_base)

Applying reference:

    obj.ref("reference")

    // Example

    obj.ref("users/001")

Methods

Val

The val method returns the value of the path determined by the reference

    obj.ref("reference").val()
    obj.ref("users/004").val() // -> { name: "Sayran", nickname: "Polaroo", id: "004" }

Set

The set method changes the value of the path determined by the reference.

    obj.ref("reference").set(value)
    obj.ref("users/002").set({
        name: "Bryan",
        nickname: "TwoNike",
        id: "002"
    }) // -> "002": { name: "Bryan", nickname: "TwoNike", id: "002" }

Update

The update method changes the desired values of a path determined by the reference.

Note: value must be an object.

    obj.ref("reference").update(value)
    obj.ref("users/001").update({
        nickname: "JPinho"
    }) // -> { name: "João Oliveira", nickname: "JPinho", id: "001" }

Delete

The delete method deletes the desired values from a path determined by the reference.

    obj.ref("reference").delete()
    obj.ref("users/003").delete() // -> { users: { "001": {...}, "002": {...}, "004": {...} } }

About

Objref, a simple object manager using reference.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published