Socket
Socket
Sign inDemoInstall

quidproquo-actionprocessor-node

Package Overview
Dependencies
11
Maintainers
1
Versions
166
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

quidproquo-actionprocessor-node

The `quidproquo-actionprocessor-node` library provides a set of generic action processors for the `quidproquo` framework, allowing you to easily integrate common functionality into your Node.js-based applications.


Version published
Maintainers
1
Weekly downloads
252
decreased by-20%

Weekly downloads

Readme

Source

quidproquo-actionprocessor-node

The quidproquo-actionprocessor-node library provides a set of generic action processors for the quidproquo framework, allowing you to easily integrate common functionality into your Node.js-based applications.

Key Features

  1. Comprehensive Action Processors: This library includes a wide range of action processors that cover various common use cases, such as date/time operations, error handling, event processing, GUID generation, logging, math operations, network requests, platform-specific functionality (e.g., delays), and system-level actions.

  2. Extensibility: The action processor architecture is designed to be highly extensible, allowing you to easily add custom action processors to meet your specific requirements.

  3. Dependency Injection: The action processors are integrated with the quidproquo dependency injection system, making it easy to compose and test your application components.

  4. Testability: The action-oriented architecture and asynchronous execution model of quidproquo-actionprocessor-node make it highly testable, with support for unit, integration, and end-to-end testing.

  5. Portability: While the quidproquo-actionprocessor-node library is designed to run on Node.js, the underlying quidproquo-core library is platform-agnostic, allowing you to potentially use these action processors in other environments as well.

Getting Started

To use the quidproquo-actionprocessor-node library, you'll need to install the package and its dependencies. You can do this using your preferred package manager, such as npm or yarn:

npm install quidproquo-actionprocessor-node

Once you have the package installed, you can start using the provided action processors in your quidproquo-based application. The library exports a set of action processors that you can import and use in your code.

Action Processors

The quidproquo-actionprocessor-node library provides the following action processors:

  1. Date/Time Action Processors:
  • DateNowActionProcessor: Retrieves the current date and time as an ISO string.
  1. Error Action Processors:
  • ErrorThrowErrorActionProcessor: Throws a custom error with a specified type, text, and stack trace.
  1. Event Action Processors:
  • (No event-specific action processors are currently implemented)
  1. GUID Action Processors:
  • GuidNewActionProcessor: Generates a new UUID.
  1. Logging Action Processors:
  • LogCreateActionProcessor: Logs a message with a specified log level and optional data.
  1. Math Action Processors:
  • MathRandomNumberActionProcessor: Generates a random number.
  1. Network Action Processors:
  • NetworkRequestActionProcessor: Performs an HTTP request with various options (method, headers, body, etc.).
  1. Platform Action Processors:
  • PlatformDelayActionProcessor: Delays the execution for a specified number of milliseconds.
  1. System Action Processors:
  • SystemBatchActionProcessor: Executes a batch of actions and returns the results.
  1. User Directory Action Processors:
  • (No user directory-specific action processors are currently implemented)

Usage

To use the action processors provided by quidproquo-actionprocessor-node, you can import them into your quidproquo-based application and integrate them with your action processor configuration. Here's an example of how you might use the DateNowActionProcessor:

import { DateNowActionProcessor, actionResult, DateActionType } from 'quidproquo-actionprocessor-node';

const processDateNow: DateNowActionProcessor = async () => {
return actionResult(new Date().toISOString());
};

export default {
[DateActionType.Now]: processDateNow,
};

In this example, we define a DateNowActionProcessor function that returns the current date and time as an ISO string. We then export this processor under the DateActionType.Now action type, which can be used in our quidproquo-based application.

Contribution and Development

If you'd like to contribute to the development of quidproquo-actionprocessor-node, please refer to the contributing guidelines for more information.

License

quidproquo-actionprocessor-node is licensed under the MIT License.

Warning: Not for Production

This project is currently under active development and should not be used in production environments. The APIs and functionality are subject to change without notice.

FAQs

Last updated on 28 Mar 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc