LibrarySubset
LibrarySubset indicates a subset of the macros and function supported by a subsettable library.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LibrarySubset():
LibrarySubset
Returns
Section titled “Returns”LibrarySubset
Properties
Section titled “Properties”disabled
Section titled “disabled”disabled:
boolean=false
disableMacros
Section titled “disableMacros”disableMacros:
boolean=false
excludeFunctions
Section titled “excludeFunctions”excludeFunctions:
EnvironmentFunction[] =[]
excludeMacros
Section titled “excludeMacros”excludeMacros:
string[] =[]
includeFunctions
Section titled “includeFunctions”includeFunctions:
EnvironmentFunction[] =[]
includeMacros
Section titled “includeMacros”includeMacros:
string[] =[]
Methods
Section titled “Methods”addExcludedFunctions()
Section titled “addExcludedFunctions()”addExcludedFunctions(…
funcs):this
AddExcludedFunctions deny-lists one or more functions from the subset.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”this
addExcludedMacros()
Section titled “addExcludedMacros()”addExcludedMacros(…
macros):this
AddExcludedMacros deny-lists one or more macros by function name.
Parameters
Section titled “Parameters”macros
Section titled “macros”…string[]
Returns
Section titled “Returns”this
addIncludedFunctions()
Section titled “addIncludedFunctions()”addIncludedFunctions(…
funcs):this
AddIncludedFunctions allow-lists one or more functions from the subset.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”this
addIncludedMacros()
Section titled “addIncludedMacros()”addIncludedMacros(…
macros):this
AddIncludedMacros allow-lists one or more macros by function name.
Parameters
Section titled “Parameters”macros
Section titled “macros”…string[]
Returns
Section titled “Returns”this
setDisabled()
Section titled “setDisabled()”setDisabled(
value):this
SetDisabled disables or enables the library.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”this
setDisableMacros()
Section titled “setDisableMacros()”setDisableMacros(
value):this
SetDisableMacros disables the macros for the library.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”this
subsetFunction()
Section titled “subsetFunction()”subsetFunction(
fn): [FunctionDecl|undefined,boolean]
SubsetFunction produces a function declaration which matches the supported subset.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”[FunctionDecl | undefined, boolean]
subsetMacro()
Section titled “subsetMacro()”subsetMacro(
macroFunction):boolean
SubsetMacro indicates whether the macro function should be included in the library subset.
Parameters
Section titled “Parameters”macroFunction
Section titled “macroFunction”string
Returns
Section titled “Returns”boolean
validate()
Section titled “validate()”validate():
Error|undefined
Validate validates the library configuration is well-formed.
Returns
Section titled “Returns”Error | undefined