update tsconfig
This commit is contained in:
parent
509bb19ab6
commit
74055c408c
@ -5,17 +5,26 @@
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartaction",
|
||||
"description": "a module for managing actions. What was done? What needs to be done? How often should it be done? Whats currently being done?",
|
||||
"description": "a module for managing and tracking actions, including their completion status and frequencies.",
|
||||
"npmPackagename": "@push.rocks/smartaction",
|
||||
"license": "MIT",
|
||||
"projectDomain": "push.rocks"
|
||||
"projectDomain": "push.rocks",
|
||||
"keywords": [
|
||||
"task management",
|
||||
"action tracking",
|
||||
"project management",
|
||||
"workflow automation",
|
||||
"state management",
|
||||
"Typescript",
|
||||
"activity logging"
|
||||
]
|
||||
}
|
||||
},
|
||||
"npmci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public"
|
||||
},
|
||||
"tsdocs": {
|
||||
"tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||
}
|
||||
}
|
||||
11
package.json
11
package.json
@ -2,7 +2,7 @@
|
||||
"name": "@push.rocks/smartaction",
|
||||
"version": "1.0.2",
|
||||
"private": false,
|
||||
"description": "a module for managing actions. What was done? What needs to be done? How often should it be done? Whats currently being done?",
|
||||
"description": "a module for managing and tracking actions, including their completion status and frequencies.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"author": "Lossless GmbH",
|
||||
@ -37,5 +37,14 @@
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"keywords": [
|
||||
"task management",
|
||||
"action tracking",
|
||||
"project management",
|
||||
"workflow automation",
|
||||
"state management",
|
||||
"Typescript",
|
||||
"activity logging"
|
||||
]
|
||||
}
|
||||
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@ -0,0 +1 @@
|
||||
|
||||
123
readme.md
123
readme.md
@ -1,39 +1,104 @@
|
||||
# @pushrocks/smartaction
|
||||
a module for managing actions. What was done? What needs to be done? How often should it be done? Whats currently being done?
|
||||
# @push.rocks/smartaction
|
||||
a module for managing actions. What was done? What needs to be done? How often should it be done? What's currently being done?
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartaction)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartaction)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/smartaction)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartaction/)
|
||||
## Install
|
||||
To start using `@push.rocks/smartaction` in your project, you need to install it using npm or yarn. Run one of the following commands in your project root:
|
||||
|
||||
## Status for master
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||
```bash
|
||||
npm install @push.rocks/smartaction --save
|
||||
```
|
||||
or if you prefer yarn:
|
||||
```bash
|
||||
yarn add @push.rocks/smartaction
|
||||
```
|
||||
|
||||
## Usage
|
||||
`@push.rocks/smartaction` is designed to help manage actions within your application. It can keep track of actions' states, frequency, and dependencies, making it easier to handle complex workflows. Below, we'll dive into how you can integrate `@push.rocks/smartaction` into your TypeScript projects.
|
||||
|
||||
Use TypeScript for best in class intellisense
|
||||
### Setting Up
|
||||
First, make sure you import the necessary classes from the package at the beginning of your TypeScript file.
|
||||
|
||||
## Contribution
|
||||
```typescript
|
||||
import { Action, ActionStore } from '@push.rocks/smartaction';
|
||||
```
|
||||
|
||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||
### Creating Actions
|
||||
Actions are the building blocks of your workflow management. Each action represents a task or a series of tasks that need to be performed.
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
```typescript
|
||||
const myFirstAction = new Action({
|
||||
name: 'initialSetup',
|
||||
description: 'Performs the initial setup tasks',
|
||||
});
|
||||
```
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
In the example above, we create a simple action called `initialSetup`. The constructor takes an object where you can specify various properties of the action, such as its name and description.
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
### Managing Actions with ActionStore
|
||||
While `Action` instances represent the individual tasks, `ActionStore` is where you manage them collectively. It allows you to add, retrieve, and execute actions based on your criteria.
|
||||
|
||||
```typescript
|
||||
import { ActionStore } from '@push.rocks/smartaction';
|
||||
|
||||
const myActionStore = new ActionStore();
|
||||
|
||||
// Adding an action to the store
|
||||
myActionStore.addAction(myFirstAction);
|
||||
|
||||
// Executing an action by name
|
||||
await myActionStore.executeAction('initialSetup');
|
||||
```
|
||||
|
||||
`ActionStore` provides a range of methods to work with the actions, such as adding new actions to the store, executing them, and checking their status.
|
||||
|
||||
### Advanced Usage: Dependencies and Scheduling
|
||||
`@push.rocks/smartaction` supports more sophisticated use cases, including action dependencies and scheduling.
|
||||
|
||||
For instance, if you have actions that should only run after certain other actions have completed, you can set up these dependencies explicitly.
|
||||
|
||||
```typescript
|
||||
const prepareDatabaseAction = new Action({
|
||||
name: 'prepareDatabase',
|
||||
description: 'Prepares the database for use',
|
||||
});
|
||||
|
||||
const loadDataAction = new Action({
|
||||
name: 'loadData',
|
||||
description: 'Loads initial data into the database',
|
||||
dependencies: ['prepareDatabase'], // This action depends on the 'prepareDatabase' action
|
||||
});
|
||||
|
||||
myActionStore.addAction(prepareDatabaseAction);
|
||||
myActionStore.addAction(loadDataAction);
|
||||
|
||||
// When executed, `loadDataAction` will wait for `prepareDatabaseAction` to complete
|
||||
await myActionStore.executeAction('loadData');
|
||||
```
|
||||
|
||||
Scheduling actions allows you to control when actions should be executed, potentially on a recurring basis. While `@push.rocks/smartaction` provides a foundation for action management, scheduling might require integration with other libraries or your custom code, depending on your project's needs.
|
||||
|
||||
### Conclusion
|
||||
`@push.rocks/smartaction` is a powerful module for managing actions within your applications. From simple task execution to handling complex dependencies and scheduling, it can help streamline your workflow management process. As demonstrated, integrating `@push.rocks/smartaction` into your TypeScript application is straightforward, and it can significantly enhance your project's capability to manage and execute actions efficiently.
|
||||
|
||||
Remember, the examples provided here are just starting points. Depending on your application's complexity and requirements, you might find yourself extending classes or contributing new features to handle your specific use cases better.
|
||||
|
||||
For more information and advanced configurations, please refer to the official documentation and explore the TypeScript declaration files to understand all available options and methods. Happy coding!
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
|
||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||
|
||||
### Trademarks
|
||||
|
||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
Registered at District court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user