Skip to content

Commit

Permalink
docs(runtime-types): add sync alias comments, punctuation nitpicks
Browse files Browse the repository at this point in the history
  • Loading branch information
stern-shawn authored and dkundel committed Nov 1, 2021
1 parent ceee356 commit 41b3e15
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions packages/serverless-runtime-types/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,8 @@ export interface TwilioResponse {
*/
setHeaders(headers: { [key: string]: string }): TwilioResponse;
/**
* 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
* 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.
*
* @param key - The name of the cookie to be set
* @param value - The value of the cookie
Expand Down Expand Up @@ -191,7 +192,17 @@ export type RuntimeSyncClientOptions = TwilioClientOptions & {
};

export type RuntimeSyncServiceContext = ServiceContext & {
/**
* Alias for `syncMaps`
*
* @see https://www.twilio.com/docs/sync/api/list-resource
*/
maps: SyncMapListInstance;
/**
* Alias for `syncLists`
*
* @see https://www.twilio.com/docs/sync/api/map-resource
*/
lists: SyncListListInstance;
};

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

0 comments on commit 41b3e15

Please sign in to comment.