string-and-object-tools 0.0.21

string-and-object-tools

0.0.21

Index ▸
- Static members
- .buildTreeFromObject
- .getContentEditableData
- .getFlattenedObject
- .getVariableSelectData
- .objectHasOwnProperty
- .replaceVariableInput
buildTreeFromApplication

Need help reading this?

Index

Static Members

▸ buildTreeFromObject

builds a object from JSON object

buildTreeFromObject

Parameters

sampleData (object) JSON object to be flattened.

prefixName

(any
            = "")

label

(stirng
            = "no label")

label defaults "no label"

name (stirng) prefix name defaults to empty

▸ getContentEditableData

Flattens a JSON object into an object needed by contentEditble compoents

getContentEditableData

Parameters

sampleData (object) JSON object to be flattened.

Returns

object: JSON object with key and value

▸ getFlattenedObject

Flattens a JSON object into an object needed by dataBrowser compoents

getFlattenedObject

Parameters

sampleData (object) JSON object to be flattened.

name (any)

▸ getVariableSelectData

Flattens a JSON object into label and value pairs

getVariableSelectData

Parameters

label

(string
            = "")

The root label the JSON properties will be appended to.

sampleData (object) JSON object to be flattened.

sampleDataName (any)

Returns

array: array of objects in {label:"","value":""} format.

▸ objectHasOwnProperty

This function takes determines if a string of dot notation matches the structure of a json object

objectHasOwnProperty

Parameters

obj (any) valid JSON object

dotNotation (any) JSON object dot notation for the object structure to be checked against

Returns

boolean: true if the object contains the property and matching structure

▸ replaceVariableInput

Replaces marked words in a string with the contencts of a JSON object

replaceVariableInput

Parameters

incomingString

(string
            = "")

String marked for replacement "Something +replaceMe"

sampleData

(object
            = {})

JSON data such as {"replaceMe":"important" }

Returns

string: String with replacemed values, such as "Somthing important"

buildTreeFromApplication

builds the tree object from an application object with version

buildTreeFromApplication

Parameters

appObj (any)

version (String) JSON object dot notation for the object structure to be checked against

obj (any) application object