Nanoseconds Produce Minutes

    @elaraai/edk-io
    TypeScript icon, indicating that this package has built-in type declarations

    3.9.3 • Public • Published

    EDK-IO

    The EDK (ELARA Development Kit for IO) is a CLI and API to manage extended features of ELARA datasources.

    Installation

    The EDK-IO package can be installed with npm:

    npm install -g @elaraai/edk-io

    Usage

    The EDK-IO can be used either as the CLI or API.

    CLI Usage

    Once the EDK-IO is installed globally, the CLI can be invoked from the command line, for example to read the EDK-IO help:

    $ edk-io --help
    Usage: edk-io [options] [command]
    
    Options:
      -V, --version   output the version number
      -h, --help      display help for command
    
    Commands:
      store           manage the ELARA file store
      detect          detect datasource expressions
      help [command]  display help for command

    API Usage

     import * as edk from '@elaraai/edk'
     import * as edk_io from '@elaraai/edk-io'
     // detect a datasource
     const project_dir = 'path_to_workspace'
     async function run() {
         // add a datasource to the project
         let config = edk_io.detectDataSource({
             type: 'csv',
             asset: 'employees.source',
             defaults: true,
             config: edk.config(project_dir),
             dir: project_dir
         });
    }
    
    run()

    Documentation

    We provide the following detailed documentation:

    License

    The EDK is licensed under the EDK Licence version LICENSE-1.04, the full version of the EDK Licence is available here.

    Release Notes

    [2022-06-02]

    @elaraai/edk-io v3.9.3

    Added

    • Added uncache command for a view

    [2022-05-19]

    General

    • Added minimum Node engine support to be 16.x
    • Upgraded Typescript to version 4.6

    @elaraai/edk-io v3.9.0

    Added

    • Added uncache command to uncache a datasource that has been cached

    [2022-04-06]

    @elaraai/edk-io v3.8.3-3

    Added

    • Added skip paramater to skip a number of rows for top.
    • Added list, size and top commands to enable interaction with the file store.

    [2021-11-18]

    @elaraai/edk-io v2.3.1

    Changed

    • Seperated input/ouput (including detection) related edk functionality into edk-io package.

    [Version 1]

    Initial public release.

    Keywords

    none

    Install

    npm i @elaraai/edk-io

    DownloadsWeekly Downloads

    4

    Version

    3.9.3

    License

    SEE LICENSE IN LICENSE.txt

    Unpacked Size

    4.15 MB

    Total Files

    7

    Last publish

    Collaborators

    • elaraai