Skip to content

useful function module when using serverless template function calls plugin

Notifications You must be signed in to change notification settings

Meterius/serverless-template-function-calls-library

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Serverless Template Function Calls Library

This package is a collection of useful functions for the usage of the serverless template function calls plugin for the serverless framework.

Functions

replaceAll(str, key, value)string

replaces all occurrences of key in the string by the value

replaceVars(str, vars)string

replaces all occurrences of vars keys in the string by the values of vars

toKebabCase(str)String

converts string to kebab case

isObject(val)boolean

checks whether val is an object

shallowCopy(val)*

create shallow copy

copy(val)*

create deep copy

setCallDel(element, func, props)

sets properties on element, calls the function on the element and resets properties on element to the previous values

mergeArrays(superArray)Array

merges elements of multiple arrays into single array

mergeProps(arr)Object

merges properties ignoring ones with double underscores of objects in array into single object

substitute(options)*

substitutes keys of vars in the keys and values of the content recursively with the values of vars and values that match a key directly are replaced by that keys value

mapSubstitute(options)Array

returns each possible substitution by using each vars from the varsArray

capitalizeString(str)String

capitalize string

concatStrings(arr)String

concatenates strings

replaceStrings()*

recursively goes through all strings values in content and replaces occurrences of keys of vars with the values of vars

replaceValues()*

recursively goes through all strings values in content and replaces them with the value if they match a key in vars

file(path)string

reads string contents of a file

unpack(arr)Object

extracts objects of an array and adds their props to the siblings of the function call

replaceAll(str, key, value) ⇒ string

replaces all occurrences of key in the string by the value

Kind: global function

Param Type
str string
key string
value string

replaceVars(str, vars) ⇒ string

replaces all occurrences of vars keys in the string by the values of vars

Kind: global function

Param Type
str string
vars Object

toKebabCase(str) ⇒ String

converts string to kebab case

Kind: global function

Param Type
str String

isObject(val) ⇒ boolean

checks whether val is an object

Kind: global function

Param Type
val *

shallowCopy(val) ⇒ *

create shallow copy

Kind: global function

Param Type
val *

copy(val) ⇒ *

create deep copy

Kind: global function

Param Type
val *

setCallDel(element, func, props)

sets properties on element, calls the function on the element and resets properties on element to the previous values

Kind: global function

Param Type
element *
func function
props Object

mergeArrays(superArray) ⇒ Array

merges elements of multiple arrays into single array

Kind: global function

Param Type
superArray Array.<Array>

mergeProps(arr) ⇒ Object

merges properties ignoring ones with double underscores of objects in array into single object

Kind: global function
Throws:

  • Error properties are not be specified multiple times
Param Type
arr Array.<Object>

substitute(options) ⇒ *

substitutes keys of vars in the keys and values of the content recursively with the values of vars and values that match a key directly are replaced by that keys value

Kind: global function

Param Type
options Object
options.vars Object
options.content *

mapSubstitute(options) ⇒ Array

returns each possible substitution by using each vars from the varsArray

Kind: global function

Param Type
options Object
options.varsArray Array.<Object>
options.content *

capitalizeString(str) ⇒ String

capitalize string

Kind: global function

Param Type
str String

concatStrings(arr) ⇒ String

concatenates strings

Kind: global function

Param Type
arr Array.<String>

replaceStrings() ⇒ *

recursively goes through all strings values in content and replaces occurrences of keys of vars with the values of vars

Kind: global function

Param Type
options.vars Object
options.content *

replaceValues() ⇒ *

recursively goes through all strings values in content and replaces them with the value if they match a key in vars

Kind: global function
Returns: * - - replaced content

Param Type
options.vars Object
options.content *

file(path) ⇒ string

reads string contents of a file

Kind: global function

Param
path

unpack(arr) ⇒ Object

extracts objects of an array and adds their props to the siblings of the function call

Kind: global function

Param Type
arr Array.<Object>

About

useful function module when using serverless template function calls plugin

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published