JSPM

tdl-tdlib-addon-build

1.2.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 6
  • Score
    100M100P100Q34909F
  • License MIT

Node.js N-API addon that provides bindings to TDLib

Package Exports

  • tdl-tdlib-addon-build
  • tdl-tdlib-addon-build/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tdl-tdlib-addon-build) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

tdl-tdlib-addon

npm

A Node.js N-API addon that provides bindings to the TDLib's libtdjson shared library.

It is meant to be used with the tdl package.

tdl-tdlib-addon provides TypeScript and Flow typings out of the box.

Installation

$ npm install tdl-tdlib-addon

API

const { TDLib, defaultLibraryFile } = require('tdl-tdlib-addon')

constructor: new TDLib(libraryFile?: string, addonPath?: string)

libraryFile is the filename that will be passed to dlopen or LoadLibraryW on Windows.

By default, libraryFile is tdjson.dll on Windows, libtdjson.dylib on macOS, and libtdjson.so on a different OS. This default value is exported as defaultLibraryFile.

addonPath is ../build/Release/td.node by default. This parameter generally should not be changed.

Examples:

new TDLib()
new TDLib('libtdjson.so')
new TDLib('libtdjson.dylib')
new TDLib('libtdjson.so', '../build/Release/td.node')

For other API see TDLib_API.md in the tdl repository root.