@chisel/typescript

Chisel Data Integration Framework TypeScript Essentials

This repository contains TypeScript typings and decorators used inside all scripts written on Chisel data integration framework.

Installation

npm install @chisel/typescript

Usage

For usage examples, see Chisel scripts examples.

Exports

// Exports of '@chisel/typescript'
import {
  Scraper,    // Namespace for all exports of '@chisel/typescript/scraper'
  Processor,  // Namespace for all exports of `@chisel/typescript/processor`
} from '@chisel/typescript';

// Exports of '@chisel/typescript/processor'
import {
  DatabaseAPI, // Database API for processors (full)
  DatabaseRef,
  TreeRef,
  PathRef,
  DataRef,
  QueryResult,
  QueryPredicateFunction,
  QueryPredicateFactory,
  Utility,
  DataMutators,
  QueryPredicates,
  DoneFunction,
  Logger,
  Colors,
  MicrosetRef
} from '@chisel/typescript/processor';

// Exports of '@chisel/typescript/scraper'
import {
  Scraper,
  ScraperDefinition,
  TargetDefinition,
  RequestMethod,
  ResponseType,
  Response,
  NextScrapers,
  Session,
  Main,
  MainFunction,
  DatabaseAPI, // Database API for scrapers (limited write-only)
  DatabaseRef,
  TreeRef,
  PathRef,
  Logger,
  Colors,
  MicrosetRef
} from '@chisel/typescript/scraper';

Transpilation

tsc --build ./tsconfig.json