Skip to content

Commit 41b3e15

Browse files
stern-shawndkundel
authored andcommitted
docs(runtime-types): add sync alias comments, punctuation nitpicks
1 parent ceee356 commit 41b3e15

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

Diff for: packages/serverless-runtime-types/types.d.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,8 @@ export interface TwilioResponse {
137137
*/
138138
setHeaders(headers: { [key: string]: string }): TwilioResponse;
139139
/**
140-
* Add a cookie to the HTTP response. Accepts the name of the cookie, its value, and any optional attributes to be assigned to the cookie
140+
* Add a cookie to the HTTP response.
141+
* Accepts the name of the cookie, its value, and any optional attributes to be assigned to the cookie.
141142
*
142143
* @param key - The name of the cookie to be set
143144
* @param value - The value of the cookie
@@ -191,7 +192,17 @@ export type RuntimeSyncClientOptions = TwilioClientOptions & {
191192
};
192193

193194
export type RuntimeSyncServiceContext = ServiceContext & {
195+
/**
196+
* Alias for `syncMaps`
197+
*
198+
* @see https://www.twilio.com/docs/sync/api/list-resource
199+
*/
194200
maps: SyncMapListInstance;
201+
/**
202+
* Alias for `syncLists`
203+
*
204+
* @see https://www.twilio.com/docs/sync/api/map-resource
205+
*/
195206
lists: SyncListListInstance;
196207
};
197208

@@ -264,7 +275,7 @@ export type RuntimeInstance = {
264275
*/
265276
getFunctions(): ResourceMap;
266277
/**
267-
* Returns a Sync Service Context object that has been configured to work with your default Sync Service
278+
* Returns a Sync Service Context object that has been configured to work with your default Sync Service.
268279
*
269280
* @param options - Optional object to configure the Sync Context, such as the name of a different Sync Service
270281
* @returns A Sync Context object for interacting with Twilio Sync

0 commit comments

Comments
 (0)