Class GeneratorBuilder<Context, Names, RuleDefs>

Type Parameters

Context
Names extends string
RuleDefs extends GenRuleMap<Names>

Index

Methods

addMany addRule addRuleRedundant build deleteRule merge patchRule typePatch widenContext create

Methods

addMany

addMany[]>(
 ...rules: CheckOverlap<ParseNamesFromList, Names, U>,
): GeneratorBuilder<
 Context,
 Names
 | ParseNamesFromList,
 {
 [K in string]: K extends keyof GenRulesToObject<
 CheckOverlap<ParseNamesFromList, Names, U, never>,
 ParseNamesFromList<CheckOverlap<ParseNamesFromList, Names, U, never>>,
 Record<never, never>,
 >
 ? GenRulesToObject<
 CheckOverlap<ParseNamesFromList, Names, U, never>,
 ParseNamesFromList<CheckOverlap<ParseNamesFromList, Names, U, never>>,
 Record<never, never>,
 >[K<K>] extends GeneratorRule<Context, K<K>>
 ? any[any]
 : never
 : K extends Names
 ? RuleDefs[K<K>] extends GeneratorRule<Context, K<K>>
 ? any[any]
 : never
 : never
 },
>
Type Parameters
- U extends readonly GeneratorRule<Context>[]
Parameters
- ...rules: CheckOverlap<ParseNamesFromList, Names, U>
Returns GeneratorBuilder<
 Context,
 Names
 | ParseNamesFromList,
 {
 [K in string]: K extends keyof GenRulesToObject<
 CheckOverlap<ParseNamesFromList, Names, U, never>,
 ParseNamesFromList<CheckOverlap<ParseNamesFromList, Names, U, never>>,
 Record<never, never>,
 >
 ? GenRulesToObject<
 CheckOverlap<ParseNamesFromList, Names, U, never>,
 ParseNamesFromList<CheckOverlap<ParseNamesFromList, Names, U, never>>,
 Record<never, never>,
 >[K<K>] extends GeneratorRule<Context, K<K>>
 ? any[any]
 : never
 : K extends Names
 ? RuleDefs[K<K>] extends GeneratorRule<Context, K<K>>
 ? any[any]
 : never
 : never
 },
>
- Defined in generator-builder/generatorBuilder.ts:115

addRule

addRule(
 rule: CheckOverlap<U, Names, GeneratorRule<Context, U, RET, ARGS>>,
): GeneratorBuilder<
 Context,
 Names
 | U,
 {
 [K in string]: K extends Names
 ? RuleDefs[K<K>] extends GeneratorRule<Context, K<K>>
 ? any[any]
 : never
 : K extends U ? GeneratorRule<Context, K<K>, RET, ARGS> : never
 },
>
Add a rule to the grammar. Will raise a typescript error if the rule already exists in the grammar.
Type Parameters
- U extends string
- RET
- ARGS extends any[]
Parameters
- rule: CheckOverlap<U, Names, GeneratorRule<Context, U, RET, ARGS>>
Returns GeneratorBuilder<
 Context,
 Names
 | U,
 {
 [K in string]: K extends Names
 ? RuleDefs[K<K>] extends GeneratorRule<Context, K<K>>
 ? any[any]
 : never
 : K extends U ? GeneratorRule<Context, K<K>, RET, ARGS> : never
 },
>
- Defined in generator-builder/generatorBuilder.ts:106

addRuleRedundant

addRuleRedundant(
 rule: GeneratorRule<Context, U, RET, ARGS>,
): GeneratorBuilder<
 Context,
 Names
 | U,
 {
 [K in string]: K extends Names
 ? RuleDefs[K<K>] extends GeneratorRule<Context, K<K>>
 ? any[any]
 : never
 : K extends U ? GeneratorRule<Context, K<K>, RET, ARGS> : never
 },
>
Add a rule to the grammar. If the rule already exists, but the implementation differs, an error will be thrown.
Type Parameters
- U extends string
- RET
- ARGS extends any[]
Parameters
- rule: GeneratorRule<Context, U, RET, ARGS>
Returns GeneratorBuilder<
 Context,
 Names
 | U,
 {
 [K in string]: K extends Names
 ? RuleDefs[K<K>] extends GeneratorRule<Context, K<K>>
 ? any[any]
 : never
 : K extends U ? GeneratorRule<Context, K<K>, RET, ARGS> : never
 },
>
- Defined in generator-builder/generatorBuilder.ts:86

build

build(): GeneratorFromRules<Context, Names, RuleDefs>
Returns GeneratorFromRules<Context, Names, RuleDefs>
- Defined in generator-builder/generatorBuilder.ts:200

deleteRule

deleteRule(
 ruleName: U,
): GeneratorBuilder<
 Context,
 Exclude<Names, U>,
 {
 [K in string]: RuleDefs[K] extends GeneratorRule<Context, K>
 ? any[any]
 : never
 },
>
Delete a grammar rule by its name.
Type Parameters
- U extends string
Parameters
- ruleName: U
Returns GeneratorBuilder<
 Context,
 Exclude<Names, U>,
 {
 [K in string]: RuleDefs[K] extends GeneratorRule<Context, K>
 ? any[any]
 : never
 },
>
- Defined in generator-builder/generatorBuilder.ts:135

merge

merge<
 OtherNames extends string,
 OtherRules extends GenRuleMap<OtherNames>,
 OW extends readonly GeneratorRule<Context>[],
>(
 GeneratorBuilder: GeneratorBuilder<Context, OtherNames, OtherRules>,
 overridingRules: OW,
): GeneratorBuilder<
 Context,
 Names
 | OtherNames
 | ParseNamesFromList<OW>,
 {
 [K in string]: K extends keyof GenRulesToObject<OW>
 ? GenRulesToObject<OW>[K<K>] extends GeneratorRule<Context, K<K>>
 ? any[any]
 : never
 : K extends Names
 ? RuleDefs[K<K>] extends GeneratorRule<Context, K<K>>
 ? any[any]
 : never
 : K extends OtherNames
 ? OtherRules[K<K>] extends GeneratorRule<Context, K<K>>
 ? any[any]
 : never
 : never
 },
>
Merge this grammar GeneratorBuilder with another. It is best to merge the bigger grammar with the smaller one. If the two builders both have a grammar rule with the same name, no error will be thrown case they map to the same ruledef object. If they map to a different object, an error will be thrown. To fix this problem, the overridingRules array should contain a rule with the same conflicting name, this rule implementation will be used.
Type Parameters
- OtherNames extends string
- OtherRules extends GenRuleMap<OtherNames>
- OW extends readonly GeneratorRule<Context>[]
Parameters
- GeneratorBuilder: GeneratorBuilder<Context, OtherNames, OtherRules>
- overridingRules: OW
Returns GeneratorBuilder<
 Context,
 Names
 | OtherNames
 | ParseNamesFromList<OW>,
 {
 [K in string]: K extends keyof GenRulesToObject<OW>
 ? GenRulesToObject<OW>[K<K>] extends GeneratorRule<Context, K<K>>
 ? any[any]
 : never
 : K extends Names
 ? RuleDefs[K<K>] extends GeneratorRule<Context, K<K>>
 ? any[any]
 : never
 : K extends OtherNames
 ? OtherRules[K<K>] extends GeneratorRule<Context, K<K>>
 ? any[any]
 : never
 : never
 },
>
- Defined in generator-builder/generatorBuilder.ts:153

patchRule

patchRule(
 patch: GeneratorRule<Context, U, RET, ARGS>,
): GeneratorBuilder<
 Context,
 Names,
 {
 [Key in string]: Key extends U
 ? GeneratorRule<Context, Key<Key>, RET, ARGS>
 : RuleDefs[Key] extends GeneratorRule<Context, Key> ? any[any] : never
 },
>
Change the implementation of an existing generator rule.
Type Parameters
- U extends string
- RET
- ARGS extends any[]
Parameters
- patch: GeneratorRule<Context, U, RET, ARGS>
Returns GeneratorBuilder<
 Context,
 Names,
 {
 [Key in string]: Key extends U
 ? GeneratorRule<Context, Key<Key>, RET, ARGS>
 : RuleDefs[Key] extends GeneratorRule<Context, Key> ? any[any] : never
 },
>
- Defined in generator-builder/generatorBuilder.ts:70

typePatch

typePatch<Patch extends { [Key in string]?: any }>(): GeneratorBuilder<
 Context,
 Names,
 {
 [Key in string]: Key extends keyof Patch
 ? RuleDefs[Key<Key>] extends GeneratorRule<
 Context,
 Key<Key>,
 any,
 Args,
 >
 ? GeneratorRule<Context, Key<Key>, Patch[Key<Key>], Args>
 : never
 : RuleDefs[Key] extends GeneratorRule<Context, Key> ? any[any] : never
 },
>
Type Parameters
- Patch extends { [Key in string]?: any }
Returns GeneratorBuilder<
 Context,
 Names,
 {
 [Key in string]: Key extends keyof Patch
 ? RuleDefs[Key<Key>] extends GeneratorRule<
 Context,
 Key<Key>,
 any,
 Args,
 >
 ? GeneratorRule<Context, Key<Key>, Patch[Key<Key>], Args>
 : never
 : RuleDefs[Key] extends GeneratorRule<Context, Key> ? any[any] : never
 },
>
- Defined in generator-builder/generatorBuilder.ts:56

widenContext

widenContext<NewContext>(): GeneratorBuilder<NewContext, Names, RuleDefs>
Type Parameters
- NewContext
Returns GeneratorBuilder<NewContext, Names, RuleDefs>
- Defined in generator-builder/generatorBuilder.ts:52

`Static`create

create<Context, Names extends string, RuleDefs extends GenRuleMap<Names>>(
args: GeneratorBuilder<Context, Names, RuleDefs>,
): GeneratorBuilder<Context, Names, RuleDefs>
Create a GeneratorBuilder from some initial grammar rules or an existing GeneratorBuilder. If a GeneratorBuilder is provided, a new copy will be created.
Type Parameters
- Context
- Names extends string
- RuleDefs extends GenRuleMap<Names>
Parameters
- args: GeneratorBuilder<Context, Names, RuleDefs>
Returns GeneratorBuilder<Context, Names, RuleDefs>
- Defined in generator-builder/generatorBuilder.ts:23
create<
 Rules extends readonly GeneratorRule[] = readonly GeneratorRule[],
 Context = Rules[0] extends GeneratorRule<context> ? context : never,
 Names extends string = ParseNamesFromList<Rules>,
 RuleDefs extends GenRuleMap<Names> = GenRulesToObject<Rules>,
>(
 rules: Rules,
): GeneratorBuilder<Context, Names, RuleDefs>
Create a GeneratorBuilder from some initial grammar rules or an existing GeneratorBuilder. If a GeneratorBuilder is provided, a new copy will be created.
Type Parameters
- Rules extends readonly GeneratorRule[] = readonly GeneratorRule[]
- Context = Rules[0] extends GeneratorRule<context> ? context : never
- Names extends string = ParseNamesFromList<Rules>
- RuleDefs extends GenRuleMap<Names> = GenRulesToObject<Rules>
Parameters
- rules: Rules
Returns GeneratorBuilder<Context, Names, RuleDefs>
- Defined in generator-builder/generatorBuilder.ts:26

Class GeneratorBuilder<Context, Names, RuleDefs>

Type Parameters

Index

Methods

Methods

addMany

Type Parameters

Parameters

addRule

Type Parameters

Parameters

Returns GeneratorBuilder< Context, Names | U, { [K in string]: K extends Names ? RuleDefs[K<K>] extends GeneratorRule<Context, K<K>> ? any[any] : never : K extends U ? GeneratorRule<Context, K<K>, RET, ARGS> : never },>

addRuleRedundant

Type Parameters

Parameters

Returns GeneratorBuilder< Context, Names | U, { [K in string]: K extends Names ? RuleDefs[K<K>] extends GeneratorRule<Context, K<K>> ? any[any] : never : K extends U ? GeneratorRule<Context, K<K>, RET, ARGS> : never },>

build

Returns GeneratorFromRules<Context, Names, RuleDefs>

deleteRule

Type Parameters

Parameters

Returns GeneratorBuilder< Context, Exclude<Names, U>, { [K in string]: RuleDefs[K] extends GeneratorRule<Context, K> ? any[any] : never },>

merge

Type Parameters

Parameters

patchRule

Type Parameters

Parameters

Returns GeneratorBuilder< Context, Names, { [Key in string]: Key extends U ? GeneratorRule<Context, Key<Key>, RET, ARGS> : RuleDefs[Key] extends GeneratorRule<Context, Key> ? any[any] : never },>

typePatch

Type Parameters

widenContext

Type Parameters

Returns GeneratorBuilder<NewContext, Names, RuleDefs>

Staticcreate

Type Parameters

Parameters

Returns GeneratorBuilder<Context, Names, RuleDefs>

Type Parameters

Parameters

Returns GeneratorBuilder<Context, Names, RuleDefs>

Settings

On This Page

Returns GeneratorBuilder<
Context,
Names
| U,
{
[K in string]: K extends Names
? RuleDefs[K<K>] extends GeneratorRule<Context, K<K>>
? any[any]
: never
: K extends U ? GeneratorRule<Context, K<K>, RET, ARGS> : never
},
>

Returns GeneratorBuilder<
Context,
Names
| U,
{
[K in string]: K extends Names
? RuleDefs[K<K>] extends GeneratorRule<Context, K<K>>
? any[any]
: never
: K extends U ? GeneratorRule<Context, K<K>, RET, ARGS> : never
},
>

Returns GeneratorBuilder<
Context,
Exclude<Names, U>,
{
[K in string]: RuleDefs[K] extends GeneratorRule<Context, K>
? any[any]
: never
},
>

Returns GeneratorBuilder<
Context,
Names,
{
[Key in string]: Key extends U
? GeneratorRule<Context, Key<Key>, RET, ARGS>
: RuleDefs[Key] extends GeneratorRule<Context, Key> ? any[any] : never
},
>

`Static`create