@skitscript/types-nodejs v7.0.0

Skitscript Types (NodeJS)

A set of Typescript types representing the entities in a Skitscript document.

Installation

Dependencies

This is a NPM package. It targets NodeJS 20.14.0 or newer on the following operating systems:

• Ubuntu 22.04
• Ubuntu 20.04
• macOS 13 (Ventura)
• macOS 12 (Monterey)
• macOS 11 (Big Sur)
• Windows Server 2022
• Windows Server 2019

It is likely also possible to use this package as part of a web browser application through tools such as webpack. This has not been tested, however.

Install as a development dependency

TypeScript types should only be installed as development dependencies for most applications:

npm install --save-dev @skitscript/types-nodejs

Install as a peer dependency

If you are developing a package with includes any of these types in its public API, additionally install it as a peer dependency so that consumers of your package know to include it as well:

npm install --save-peer @skitscript/types-nodejs

Usage

Import and use the exported types:

import { Document } from "@skitscript/types-nodejs";

Parsing

Documents

• Document
• InvalidDocument
• ValidDocument

Instructions

• ClearInstruction
• EmoteInstruction
• EntryAnimationInstruction
• ExitAnimationInstruction
• Instruction
• JumpInstruction
• LineInstruction
• LocationInstruction
• MenuOptionInstruction
• SetInstruction
• SpeakerInstruction

Formatting

• Formatted
• Run

Conditions

• Condition
• EveryFlagClearCondition
• EveryFlagSetCondition
• FlagClearCondition
• FlagSetCondition
• SomeFlagsClearCondition
• SomeFlagsSetCondition

Identifiers

• Identifier
• IdentifierContext
• IdentifierInstance
• IdentifierReference
• IdentifierType

Warnings

• DuplicateIdentifierInListWarning
• EmptyLabelWarning
• FlagNeverReferencedWarning
• FlagNeverSetWarning
• InconsistentIdentifierWarning
• UnreachableWarning
• UnreferencedLabelWarning
• Warning

Errors

• DuplicateLabelError
• Error
• IncompleteEscapeSequenceError
• InvalidEscapeSequenceError
• UndefinedLabelError
• UnparsableError
• UnterminatedBoldError
• UnterminatedCodeError
• UnterminatedItalicError

Interpreting

States

• InterpreterState
• InterpreterStateRun
• InvalidInterpreterState
• ValidInterpreterState

Characters

• EnteringInterpreterStateCharacterState
• ExitingInterpreterStateCharacterState
• InterpreterStateCharacter
• InterpreterStateCharacterState
• NotPresentInterpreterStateCharacterState
• PresentInterpreterStateCharacterState

Interactions

• DismissInterpreterStateInteraction
• InterpreterStateInteraction
• MenuInterpreterStateInteraction
• MenuInterpreterStateInteractionOption

Errors

• InfiniteLoopInterpreterStateError
• InterpreterStateError

Mapping

Maps

• InvalidMap
• Map
• MapCharacter
• MapStateRun
• ValidMap

States

• MapState

Characters

• EnteringMapStateCharacter
• ExitingMapStateCharacter
• MapStateCharacter
• NotPresentMapStateCharacter
• PresentMapStateCharacter

Interactions

• DismissMapStateInteraction
• MapStateInteraction
• MenuMapStateInteraction
• MenuMapStateInteractionOption

Errors

• InfiniteLoopMapError
• MapError