Skip to content

Commit 3cee97a

Browse files
committed
Rename ObjectsTypes to AblyObjectsTypes
Decided to rename to `AblyObjectsTypes` to avoid using a generic name like `ObjectsTypes` in a global namespace, see [1] [1] ably/ably-js#2007 (comment)
1 parent 86b9703 commit 3cee97a

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

content/liveobjects/typing.textile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ blang[javascript].
1414

1515
If you are using TypeScript in your project, you can leverage LiveObjects' built-in TypeScript support to ensure type safety and enable autocompletion when working with objects on a channel.
1616

17-
h2(#global). Global ObjectsTypes interface
17+
h2(#global). Global AblyObjectsTypes interface
1818

19-
You can type objects on all your channels by defining a global @ObjectsTypes@ interface. If you only want to type the root object for a specific channel, see the "Typing channel.objects.getRoot()":#getroot section below.
19+
You can type objects on all your channels by defining a global @AblyObjectsTypes@ interface. If you only want to type the root object for a specific channel, see the "Typing channel.objects.getRoot()":#getroot section below.
2020

21-
Define the @ObjectsTypes@ interface in a type declaration file. You can create a file named @ably.config.d.ts@ in the root of your application:
21+
Define the @AblyObjectsTypes@ interface in a type declaration file. You can create a file named @ably.config.d.ts@ in the root of your application:
2222

2323
blang[javascript].
2424

@@ -35,7 +35,7 @@ blang[javascript].
3535
};
3636

3737
declare global {
38-
export interface ObjectsTypes {
38+
export interface AblyObjectsTypes {
3939
root: MyCustomRoot;
4040
}
4141
}

0 commit comments

Comments
 (0)