Class SentenceBuilder

Index

Constructors

Methods

buildSVO buildSV buildSVC combineClauses addModifiers buildFromStructure validateStructure

Constructors

constructor

new SentenceBuilder(chance?: Chance): SentenceBuilder
Parameters
- Optionalchance: Chance
Returns SentenceBuilder
- Defined in core/SentenceBuilder.ts:36

Methods

buildSVO

buildSVO(
    subject: string,
    verb: string,
    object: string,
    options?: { adjective?: string; adverb?: string; article?: string },
): string
Build a Subject-Verb-Object sentence
Parameters
- subject: string
- verb: string
- object: string
- Optionaloptions: { adjective?: string; adverb?: string; article?: string }
Returns string
- Defined in core/SentenceBuilder.ts:82

buildSV

buildSV(
    subject: string,
    verb: string,
    options?: {
        adjective?: string;
        adverb?: string;
        complement?: string;
        article?: string;
    },
): string
Build a Subject-Verb sentence (intransitive)
Parameters
- subject: string
- verb: string
- Optionaloptions: { adjective?: string; adverb?: string; complement?: string; article?: string }
Returns string
- Defined in core/SentenceBuilder.ts:124

buildSVC

buildSVC(
    subject: string,
    verb: string,
    complement: string,
    options?: { adjective?: string; adverb?: string; article?: string },
): string
Build a Subject-Verb-Complement sentence
Parameters
- subject: string
- verb: string
- complement: string
- Optionaloptions: { adjective?: string; adverb?: string; article?: string }
Returns string
- Defined in core/SentenceBuilder.ts:163

combineClauses

combineClauses(
    clause1: string,
    clause2: string,
    conjunction: "and" | "or" | "but" | "while" | "as",
): string
Build a sentence with clause combination
Parameters
- clause1: string
- clause2: string
- conjunction: "and" | "or" | "but" | "while" | "as"
Returns string
- Defined in core/SentenceBuilder.ts:195

addModifiers

addModifiers(
sentence: string,
modifiers: { adjectives?: string[]; adverbs?: string[] },
): string
Add modifiers to a sentence
Parameters
- sentence: string
- modifiers: { adjectives?: string[]; adverbs?: string[] }
Returns string
- Defined in core/SentenceBuilder.ts:205

buildFromStructure

buildFromStructure(structure: SentenceStructure): string
Build a sentence from a structure definition
Parameters
- structure: SentenceStructure
Returns string
- Defined in core/SentenceBuilder.ts:256

validateStructure

validateStructure(sentence: string): boolean
Validate sentence structure
Parameters
- sentence: string
Returns boolean
- Defined in core/SentenceBuilder.ts:364