Noteworthy Programs Map

    @axiomhq/axiom-node
    TypeScript icon, indicating that this package has built-in type declarations

    0.5.0 • Public • Published

    Axiom Node

    Workflow Latest Release License

    Alt


    Table of Contents

    1. Introduction
    2. Installation
    3. Authentication
    4. Usage
    5. Documentation
    6. Contributing
    7. License

    Introduction

    Axiom Node is a NodeJS package for accessing the Axiom API.

    Installation

    Install using npm

    npm i @axiomhq/axiom-node

    Install from source

    git clone https://github.com/axiomhq/axiom-node
    cd axiom-node
    npm install

    Authentication

    The client is initialized with the url of the deployment and an access token when using Axiom Selfhost or an access token and the users organization id when using Axiom Cloud.

    The access token can be a personal token retrieved from the users profile page or an ingest token retrieved from the settings of the Axiom deployment.

    The personal access token grants access to all resources available to the user on his behalf.

    The ingest token just allows ingestion into the datasets the token is configured for.

    Usage

    // Export `AXIOM_TOKEN` and `AXIOM_ORG_ID` for Axiom Cloud
    // Export `AXIOM_URL` and `AXIOM_TOKEN` for Axiom Selfhost
    
    import Client from '@axiomhq/axiom-node';
    
    const client = new Client();
    
    // ...

    For more sample code snippets, head over to the examples directory.

    Documentation

    You can find the Axiom and Axiom node documentation on the docs website.

    The documentation is divided into several sections:

    Contributing

    The main aim of this repository is to continue developing and advancing Axiom Node, making it faster and simpler to use. Kindly check our contributing guide on how to propose bugfixes and improvements, and submitting pull requests to the project

    License

    © Axiom, Inc., 2021

    Distributed under MIT License (The MIT License).

    See LICENSE for more information.

    Install

    npm i @axiomhq/axiom-node

    DownloadsWeekly Downloads

    661

    Version

    0.5.0

    License

    MIT

    Unpacked Size

    52 kB

    Total Files

    36

    Last publish

    Collaborators

    • seiflotfy
    • bahlo
    • mhr3
    • lukasmalkmus
    • cdeutsch
    • kevinehosford
    • axiomneil