Skip to content

Add endpoint doc string #322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lawrence-forooghian merged 1 commit into from
May 29, 2025
Merged

Add endpoint doc string #322

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions textile/api-docstrings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ Passes additional client-specific properties to the REST [`constructor()`]{@link
| defaultTokenParams: TokenParams? ||| TO3j11 | When a [`TokenParams`]{@link TokenParams} object is provided, it overrides the client library defaults when issuing new Ably Tokens or Ably [`TokenRequest`s]{@link TokenRequest}. |
| echoMessages: Bool default true ||| RTC1a, TO3h | If `false`, prevents messages originating from this connection being echoed back on the same connection. The default is `true`. |
| environment: String? ||| RSC15b, TO3k1 | Enables a [custom environment](https://ably.com/docs/platform-customization) to be used with the Ably service. |
| endpoint: String? ||| REC1b, TO3k8 | Set a routing policy or FQDN to connect to Ably. See [platform customization](https://ably.com/docs/platform-customization). |
| logHandler: ||| platform specific - TO3c | Controls the log output of the library. This is a function to handle each line of log output. |
| logLevel: ||| platform specific - TO3b | Controls the verbosity of the logs output from the library. Levels include `verbose`, `debug`, `info`, `warn` and `error`. |
| logExceptionReportingUrl: String default "[library specific]" ||| TO3m (deprecated) | DEPRECATED: this property is deprecated and will be removed in a future version. Defaults to a string value for an Ably error reporting DSN (Data Source Name), which is typically a URL in the format `https://[KEY]:[SECRET]@errors.ably.io/[ID]`. When set to `null`, `false` or an empty string (depending on what is idiomatic for the platform), exception reporting is disabled. |
Expand Down
Loading