init()

Function signature

function init(options: {
  apiKeys: string[];
  logger?: Logger;
}): void

Initializes the Tafrigh library with the provided Wit.ai API keys and optional custom logger. You must call this function before using transcribe() or other Tafrigh functions. The API keys are used to authenticate requests to the Wit.ai speech-to-text service.

Parameters

options

object

required

Configuration options for initialization

Show properties

apiKeys

string[]

required

Array of Wit.ai API keys to use for transcription. Multiple keys enable concurrent transcription of audio chunks. The library rotates through the provided keys to distribute requests.

logger

Logger

Optional custom logger instance for logging library operations. The logger should implement the Logger interface with optional methods: debug, info, warn, error, and trace. If not provided, the library uses a default logger.

interface Logger {
  debug?: (message: string, ...args: any[]) => void;
  info?: (message: string, ...args: any[]) => void;
  warn?: (message: string, ...args: any[]) => void;
  error?: (message: string, ...args: any[]) => void;
  trace?: (message: string, ...args: any[]) => void;
}

Returns

void

This function does not return a value.

Examples

Basic initialization

import { init } from 'tafrigh';

init({
  apiKeys: ['your-wit-ai-api-key']
});

Multiple API keys for concurrent transcription

import { init } from 'tafrigh';

init({
  apiKeys: [
    'wit-ai-key-1',
    'wit-ai-key-2',
    'wit-ai-key-3'
  ]
});

With multiple API keys, Tafrigh can transcribe audio chunks in parallel, significantly improving performance for large files.

Custom logger

import { init } from 'tafrigh';

const customLogger = {
  debug: (msg: string) => console.debug(`[DEBUG] ${msg}`),
  info: (msg: string) => console.info(`[INFO] ${msg}`),
  warn: (msg: string) => console.warn(`[WARN] ${msg}`),
  error: (msg: string) => console.error(`[ERROR] ${msg}`),
  trace: (msg: string) => console.trace(`[TRACE] ${msg}`)
};

init({
  apiKeys: ['your-wit-ai-api-key'],
  logger: customLogger
});

Using console as logger

import { init } from 'tafrigh';

init({
  apiKeys: ['your-wit-ai-api-key'],
  logger: console
});

The standard console object implements the Logger interface and can be used directly.

You must call init() before using any other Tafrigh functions. Attempting to transcribe without initialization will result in an error.

Core Functions

Types

Configuration

Function signature

Parameters

Returns

Examples

Basic initialization

Multiple API keys for concurrent transcription

Custom logger

Using console as logger

Build docs developers (and LLMs) love

Core Functions

Types

Configuration

​Function signature

​Parameters

​Returns

​Examples

​Basic initialization

​Multiple API keys for concurrent transcription

​Custom logger

​Using console as logger

Build docs developers (and LLMs) love

Function signature

Parameters

Returns

Examples

Basic initialization

Multiple API keys for concurrent transcription

Custom logger

Using console as logger