@darlean/app-lib v1.0.1-alpha.10

Darlean JS App

Library for creating JavaScript/TypeScript Darlean apps

IMPORTANT: Darlean is still in alpha. Functionality may change in backwards-incompatible ways. Use at your own risk! We are working hard to reach beta and stable!

Modules

Note: Technically, this library consists of only one module, but it is better for the structure of the automatically generated documentation to artificially treat separate files as modules. When using the types and function of this library from within custom code, they are all simply part of the toplevel @darlean/app-lib module entry point.

The Darlean app-lib provides the following key functionality:

• [actorFactory|Creating] regular and service actors that derive from [BaseActor] in module [actorfactory].

In addition to that it provides a lot of supportive functionality:

• Shared/exclusive locks with reentrancy and take-over functionality in module [selock]
• Serializeable data objects with support for text, binary and struct attachments in module [structs]
• Containers that contain and transfer text, binary and struct data over the network in module [containers]
• Binary encoding of containers in module [binaryencoding]
• Various types in module [types]
• Various utility functions (like [parallel], [replaceAll] and [wildcardMatch]) in module [util].

Getting started

This library contains all the types and functionality required for implementing a Darlean application. Normally, you do not directly need this library, because you would be using @darlean/daemon-rha instead, which is fully packaged with the functionality from this library plus all helpers plus it can very easily be run as a daemon.

More information: http://darlean.io

TODO: Finish this readme

Functionality

Installation

Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.

Usage

Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

Support

Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.

Roadmap

If you have ideas for releases in the future, it is a good idea to list them in the README.

Contributing

State if you are open to contributions and what your requirements are for accepting them.

For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.

You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.

Authors and acknowledgment

Show your appreciation to those who have contributed to the project.

License

For open source projects, say how it is licensed.

Project status

If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.