Skip to content

Commit b82aaac

Browse files
committed
docs(readme): improve examples
1 parent e36a4be commit b82aaac

File tree

2 files changed

+21
-3
lines changed

2 files changed

+21
-3
lines changed

Diff for: packages/serverless-runtime-types/README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,19 @@ If you want to use the types in JavaScript to get autocomplete in VS Code and
3030
other editors using the TypeScript language server:
3131

3232
```js
33-
/// <reference path="../node_modules/@twilio-labs/serverless-runtime-types/index.d.ts"/>
34-
35-
exports.handler = function(context, event, callback) {
33+
/// <reference path="../../node_modules/@twilio-labs/serverless-runtime-types/index.d.ts"/>
34+
35+
/**
36+
* @param {import('@twilio-labs/serverless-runtime-types').Context} context
37+
* @param {{}} event
38+
* @param {import('@twilio-labs/serverless-runtime-types').ServerlessCallback} callback
39+
*/
40+
exports.handler = function (context, event, callback) {
3641
let twiml = new Twilio.twiml.MessagingResponse();
3742
twiml.message('Hello World');
3843
callback(null, twiml);
3944
};
45+
4046
```
4147

4248
### In TypeScript
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
/// <reference path="../../node_modules/@twilio-labs/serverless-runtime-types/index.d.ts"/>
2+
3+
/**
4+
* @param {import('@twilio-labs/serverless-runtime-types').Context} context
5+
* @param {{}} event
6+
* @param {import('@twilio-labs/serverless-runtime-types').ServerlessCallback} callback
7+
*/
8+
exports.handler = function(context, event, callback) {
9+
let twiml = new Twilio.twiml.MessagingResponse();
10+
twiml.message('Hello World');
11+
callback(null, twiml);
12+
};

0 commit comments

Comments
 (0)