Skip to content

Commit

Permalink
Update the readme and types
Browse files Browse the repository at this point in the history
  • Loading branch information
eilvelia committed Oct 5, 2023
1 parent 871d8d8 commit e2420ca
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
})
```
Expand Down Expand Up @@ -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.
4 changes: 2 additions & 2 deletions packages/tdl/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -147,7 +147,7 @@ export class Client {
/**
* @deprecated Use `tdl.configure` and `tdl.createClient` instead. See the
* [email protected] 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')
Expand Down
4 changes: 2 additions & 2 deletions packages/tdl/index.js.flow
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -147,7 +147,7 @@ declare export class Client {
/**
* @deprecated Use `tdl.configure` and `tdl.createClient` instead. See the
* [email protected] 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')
Expand Down

0 comments on commit e2420ca

Please sign in to comment.