Skip to main content

Installation

Install the package​

npm install farseer-client@npm:@farseerdev/farseer-client

This installs the package under the name farseer-client, which is how the examples in these docs import it. A Farseer App folder created with the Farseer CLI already has it.

Requirements​

  • Node.js >= 18.17
  • TypeScript >= 5.0 (recommended)

Peer Dependencies​

The following packages are included with farseer-client:

PackageVersionPurpose
arquero^5.4.1Data transformation and table operations
axios^1.20.0HTTP client for external API integration
exceljs^4.4.0Excel file reading and writing
mssql^10.0.4Microsoft SQL Server connectivity

Basic Setup​

import { FarseerClient } from 'farseer-client';

// Auto-configuration from environment variables
const client = new FarseerClient();

Or import everything under a namespace:

import * as farseer from 'farseer-client';

const client = new farseer.FarseerClient();

Next Steps​