@code-engine/types

CodeEngine type definitions

This is a TypeScript type definition library that's used inside CodeEngine. It contains common type definitions that are used across many CodeEngine packages. In addition, each CodeEngine package may have its own type definitions that are specific to that package.

NOTE: This is an internal library that is only intended to be used by CodeEngine. Using it outside of CodeEngine is discouraged.

Types

Here are the most significant types in this library:

Type	Description
CodeEngine	An instance of CodeEngine. Each instance has its own set of plugins and manages its own pool of worker threads.
File	A CodeEngine "file". This does not necessarily correspond to a file on disk. Files are a virtual concept with a path, name, and data contents. Those values could come from a database, a CMS, an RSS feed, or any other source.
FileInfo	The information necessary to create a File object. This is a simple POJO object with mostly optional fields. Plugins can simply return one or more of these objects, and CodeEngine will create full File objects from them.
Plugin	The interface for CodeEngine plugins. Any plugin can implement some or all of the plugin methods to hook into various parts of the CodeEngine lifecycle.
ModuleDefinition	This object references a JavaScript module. It's used to load CodeEngine plugins on worker threads rather than the main thread, which improves performance and throughput in many cases.
Run	Information about the current CodeEngine run. This object is passed to many plugin methods.
Logger	CodeEngine's logging methods. Plugins should use these logging methods rather than console.log() or process.stdout.write().
Summary	When a run completes, CodeEngine returns this summary object. It's also emitted via the "finished" event.

Contributing

Contributions, enhancements, and bug-fixes are welcome! Open an issue on GitHub and submit a pull request.

Building

To build the project locally on your computer:

1. Clone this repo
   git clone https://github.com/CodeEngineOrg/code-engine-types.git

2. Install dependencies
   npm install

3. Build the code
   npm run build

4. Run the tests
   npm test

License

@code-engine/types is 100% free and open-source, under the MIT license. Use it however you want.

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

Big Thanks To

Thanks to these awesome companies for their support of Open Source developers ❤