Ampsalesfunnels NPM

ampsalesfunnels

Functions

Typedefs

getConfig(rootPath)

Kind: global function

Param	Type	Description
rootPath	string	the root directory of the project

run(command)

Kind: global function

Param	Type	Description
command	string	supported AMPSalesfunnels commands: start, startproduction, build, clean, validate, netlifyDeploySandbox, netlifyDeployProduction

ampsalesfunnelsUiClean(done)

Kind: global function

Param	Type	Description
done	*	done function to call at end of task

dotenvHandler(request, response, next)

Kind: global function

Param	Type
request	*
response	*
next	*

packageJsonHandler(request, response, next)

Kind: global function

Param	Type
request	*
response	*
next	*

emailSendHandler(request, response, next)

Kind: global function

Param	Type
request	*
response	*
next	*

validateHandler(request, response, next)

Kind: global function

Param	Type
request	*
response	*
next	*

ampsalesfunnelsUIAPI(corsOrigin)

Kind: global function

Param	Type	Description
corsOrigin	string	domain accessing the AMPSalesfunnels UI API

dotenvExistsAndValid(path) ⇒

Kind: global function Returns: ValidationResults[]

Param	Type
path	string

dotenvExistsAndValid(path) ⇒
- ~validationResults : Array.<ValidationResult>
- ~validationResult : ValidationResult

dotenvExistsAndValid~validationResults : Array.<ValidationResult>

Kind: inner constant of dotenvExistsAndValid

dotenvExistsAndValid~validationResult : ValidationResult

Kind: inner constant of dotenvExistsAndValid

validateSandboxProduction(dotenvConfig, variable) ⇒ ValidationResult

Kind: global function

Param	Type	Description
dotenvConfig	*	.env configuration
variable	string	variable base name

logValidationResults(validationResults) ⇒ void

Kind: global function

Param	Type
validationResults	Array.<ValidationResult>

packageJsonValidateAll(filepath) ⇒

Kind: global function Returns: ValidationResults[]

Param	Type
filepath	string

packageJsonExistsAndValid(filepath) ⇒

Kind: global function Returns: ValidationResults[]

Param	Type
filepath	string

validateAll(rootPath) ⇒ Array.<ValidationResult>

Kind: global function

Param	Type
rootPath	string

validateAll~validationResults : Array.<ValidationResult>

Kind: inner property of validateAll

validateJsonWithSchema(filepath, schemafilepath) ⇒ Object

Kind: global function

Param	Type	Description
filepath	string	file path to the JSON file
schemafilepath	string	file path to the JSON Schema file

validateJsonWithSchema~validationResults : Array.<ValidationResult>

Kind: inner constant of validateJsonWithSchema

loadDotenv(filepath) ⇒ Object.<string, string>

Kind: global function Returns: Object.<string, string> -

Param	Type	Description
filepath	string	path to .env file

loadPackageJson(filepath) ⇒ Object.<string, string>

Kind: global function Returns: Object.<string, string> -

Param	Type	Description
filepath	string	path to .env file

doneCallback : function

Kind: global typedef

Severity : 'WARNING' | 'ERROR'

Kind: global typedef

ValidationResult : object

Kind: global typedef Properties

Name	Type	Description
severity	Severity	severity of the validation result (WARNING, ERROR)
title	string	title of the validation result
description	string	description of the validation result
solution	string	key indicating solution for validation result (used by AMPSalesfunnels UI)