Skip to content

Commit

Permalink
Merge pull request #1694 from ably/fix-lint-warnings
Browse files Browse the repository at this point in the history
Fix lint warnings
  • Loading branch information
owenpearson authored Mar 14, 2024
2 parents 354353d + 35b45a9 commit e71ed5f
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
3 changes: 3 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ module.exports = {
extends: [
'plugin:jsdoc/recommended',
],
rules: {
"jsdoc/check-tag-names": ["warn", { "definedTags": ["experimental"] }],
},
},
],
ignorePatterns: [
Expand Down
8 changes: 3 additions & 5 deletions ably.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1164,7 +1164,6 @@ declare namespace Types {
* Controls the log output of the library. This is a function to handle each line of log output. If you do not set this value, then `console.log` will be used.
*
* @deprecated This property is deprecated and will be removed in a future version. Use the {@link ClientOptions.logHandler} client option instead.
*
* @param msg - The log message emitted by the library.
*/
handler?: (msg: string) => void;
Expand Down Expand Up @@ -3101,14 +3100,13 @@ declare namespace Types {
*/
get(name: string, channelOptions?: ChannelOptions): T;
/**
* Creates a new {@link ChannelBase} or {@link RealtimeChannelBase} object, with the specified channel {@link DeriveOptions}
* and {@link ChannelOptions}, or returns the existing channel object.
*
* @experimental This is a preview feature and may change in a future non-major release.
* This experimental method allows you to create custom realtime data feeds by selectively subscribing
* to receive only part of the data from the channel.
* See the [announcement post](https://pages.ably.com/subscription-filters-preview) for more information.
*
* Creates a new {@link ChannelBase} or {@link RealtimeChannelBase} object, with the specified channel {@link DeriveOptions}
* and {@link ChannelOptions}, or returns the existing channel object.
*
* @param name - The channel name.
* @param deriveOptions - A {@link DeriveOptions} object.
* @param channelOptions - A {@link ChannelOptions} object.
Expand Down
7 changes: 6 additions & 1 deletion src/platform/react-hooks/sample-app/src/script.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,12 @@ import * as Ably from 'ably';
import App from './App.js';
import { AblyProvider } from '../../src/index.js';

const container = document.getElementById('root')!;
const rootId = 'root';
const container = document.getElementById(rootId);

if (!container) {
throw new Error(`No element found with id #${rootId} found`);
}

function generateRandomId() {
return Math.random().toString(36).substr(2, 9);
Expand Down

0 comments on commit e71ed5f

Please sign in to comment.