From e2420caca8134d0d3d2228469cb45c23af6a32ba Mon Sep 17 00:00:00 2001 From: Bannerets Date: Thu, 5 Oct 2023 22:28:39 +0000 Subject: [PATCH] Update the readme and types --- README.md | 4 ++-- packages/tdl/index.d.ts | 4 ++-- packages/tdl/index.js.flow | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f65f313..7e091c4 100644 --- a/README.md +++ b/README.md @@ -148,7 +148,7 @@ tdl.configure({ libdir: '/usr/local/lib', // Verbosity level of TDLib. By default, it is 2. verbosityLevel: 3, - // Experimental option. Defaults to false. + // Experimental option. Disabled by default. useNewTdjsonInterface: false }) ``` @@ -526,4 +526,4 @@ symbols. - Segmentation fault -Most likely, the cause of the segfault is the same as above. +The cause of the segfault might be the same as above. diff --git a/packages/tdl/index.d.ts b/packages/tdl/index.d.ts index 3d3f5f3..b4645d9 100644 --- a/packages/tdl/index.d.ts +++ b/packages/tdl/index.d.ts @@ -34,7 +34,7 @@ export type TDLibConfiguration = { verbosityLevel?: number | 'default', /** * Experimental option. Use the new tdjson interface (`td_create_client_id` - * and other functions). */ + * and other functions) that was added in TDLib v1.7.0. */ useNewTdjsonInterface?: boolean, /** * Advanced option. Configures the delay for the `receive` tdjson function. @@ -147,7 +147,7 @@ export class Client { /** * @deprecated Use `tdl.configure` and `tdl.createClient` instead. See the * tdl@7.3.1 entry in `CHANGELOG.md` for additional information. The new - * approach to create a client is: + * approach to create a client is (`tdl-tdlib-addon` is no longer needed): * ``` * const tdl = require('tdl') * tdl.configure({ tdjson: 'path to tdjson' }) // was: new TDLib('path to tdjson') diff --git a/packages/tdl/index.js.flow b/packages/tdl/index.js.flow index 0df2d56..c22108a 100644 --- a/packages/tdl/index.js.flow +++ b/packages/tdl/index.js.flow @@ -34,7 +34,7 @@ export type TDLibConfiguration = { verbosityLevel?: number | 'default', /** * Experimental option. Use the new tdjson interface (`td_create_client_id` - * and other functions). */ + * and other functions) that was added in TDLib v1.7.0. */ useNewTdjsonInterface?: boolean, /** * Advanced option. Configures the delay for the `receive` tdjson function. @@ -147,7 +147,7 @@ declare export class Client { /** * @deprecated Use `tdl.configure` and `tdl.createClient` instead. See the * tdl@7.3.1 entry in `CHANGELOG.md` for additional information. The new - * approach to create a client is: + * approach to create a client is (`tdl-tdlib-addon` is no longer needed): * ``` * const tdl = require('tdl') * tdl.configure({ tdjson: 'path to tdjson' }) // was: new TDLib('path to tdjson')