@opendxl/dxl-streaming-client

0.1.1 • Public • Published

OpenDXL Streaming JavaScript Client Library

Latest NPM Version License Actions Status JavaScript Style Guide

Overview

The OpenDXL Streaming JavaScript client library is used to consume records from and produce records to a Data Exchange Layer (DXL) Streaming Service.

The DXL Streaming Service exposes a REST-based API that communicates with a back-end streaming platform (Kafka, Kinesis, etc.). The streaming service performs authentication and authorization and exposes methods to retrieve and produce records.

One concrete example of a DXL Streaming Service is the McAfee Investigator "Events feed".

Documentation

See the Wiki for an overview of the OpenDXL Streaming JavaScript client library and examples.

See the OpenDXL Streaming JavaScript Client Library Documentation for installation instructions, API documentation, and examples.

Installation

To start using the OpenDXL Streaming JavaScript Client Library:

  • Download the Latest Release
  • Extract the release .zip file
  • View the README.html file located at the root of the extracted files.
    • The README links to the documentation which includes installation instructions, API details, and samples.
    • The SDK documentation is also available on-line here.

Bugs and Feedback

For bugs, questions and discussions please use the GitHub Issues.

LICENSE

Copyright 2018, McAfee LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Package Sidebar

Install

npm i @opendxl/dxl-streaming-client

Weekly Downloads

1

Version

0.1.1

License

Apache-2.0

Unpacked Size

72 kB

Total Files

14

Last publish

Collaborators

  • kshitiz-trellix
  • vvanjara-mcafee
  • csmith-opendxl