@fullstackcraftllc/codevideo-types
v1.5.5
Published
TypeScript types for the CodeVideo ecosystem.
Downloads
598
Maintainers
Readme
codevideo-types
TypeScript types used around the CodeVideo ecosystem.
Theory
A software course is represented by the top level interface ICourse
. A course is made up of an array of ILessons
, which are made up of a series of IActions
. Each of ICourse
, ILesson
, and IAction
also have additional metadata properties.
IAction
IAction
- The bread and butter of all things CodeVideo. An action is defined by a name
and a value
and can perform all possible actions in the CodeVideo ecosystem. Examples include type-editor
, type-terminal
, arrow-up
, enter
, etc.
Action Names
A convenience array of all possible action names is available at AllActionStrings.
Action Values
Action values are always strings, but typically represent a number when they are keyboard actions such as arrow-up
, enter
, etc. These are catalogued in RepeatableActionNames.
Project Snapshots
A project snapshot is a snapshot of the state of a project at a given point in time. It is represented by the IProjectSnapshot
interface. Any instance of IProjectSnapshot
can be derived by evaluating the steps in the project up to the point in time that the snapshot was taken.