parsePublicodes

API / publicodes / parsePublicodes

function parsePublicodes<ContextNames, NewRulesNames>(
   rawRules, 
   partialContext?, 
   __namedParameters?
): Pick<Context<ContextNames | NewRulesNames>, "parsedRules" | "nodesTypes" | "referencesMaps" | "rulesReplacements">;

Defined in: packages/core/src/parsePublicodes.ts:200

Experimental

Parse a set of publicodes rules

Allows to add new rules to a previously parsed set of rules (partialContext)

Type Parameters

Type Parameter
`ContextNames` extends `string`
`NewRulesNames` extends `string`

Parameters

Parameter	Type	Description
`rawRules`	`RawPublicodes`<`NewRulesNames`>	The new rules to parse
`partialContext?`	`PartialContext`<`ContextNames`>	The context to use for the parsing (if we want to add a set of rules to a previously parsed one)
`__namedParameters?`	{ `mutateParsedRules?`: `boolean`; }	-
`__namedParameters.mutateParsedRules?`	`boolean`	-

Returns

Pick<Context<ContextNames | NewRulesNames>, "parsedRules" | "nodesTypes" | "referencesMaps" | "rulesReplacements">

The new context containing the parsed rules, the nodes types, the references maps and the rules replacements