@twilio-labs/serverless-runtime-types
v2.2.1@twilio-labs/serverless-runtime-types
TypeScript definitions to define globals for the Twilio Serverless runtime.
If you want to use the types in JavaScript to get autocomplete in VS Code and
other editors using the TypeScript language server: For TypeScript you can use the same technique if you want to limit the global
types to that file. Alternatively, you can use one of the following two options
to use the definitions. You can also import the specific types without setting the global types: This project welcomes contributions from the community. Please see the Please be aware that this project has a Code of Conduct. The tldr; is to just be excellent to each other ❤️ Thanks goes to these wonderful people (emoji key):
Installation
npm install @twilio-labs/serverless-runtime-types
Example
In JavaScript
/// <reference path="../../node_modules/@twilio-labs/serverless-runtime-types/index.d.ts"/>
/**
* @param {import('@twilio-labs/serverless-runtime-types').Context} context
* @param {{}} event
* @param {import('@twilio-labs/serverless-runtime-types').ServerlessCallback} callback
*/
exports.handler = function(context, event, callback) {
let twiml = new Twilio.twiml.MessagingResponse();
twiml.message("Hello World");
callback(null, twiml);
};
In TypeScript
Option 1: Modify your
tsconfig.json
{
"compilerOptions": {
"types": ["node_modules/@twilio-labs/serverless-runtime-types/index.d.ts"]
}
}
Option 2: Import the file
import "@twilio-labs/serverless-runtime-types";
export function handler(context, event, callback) {
let twiml = new Twilio.twiml.MessagingResponse();
twiml.message("Hello World");
callback(null, twiml);
}
Alternative Usage
import { RuntimeInstance } from "@twilio-labs/serverless-runtime-types/types";
function listSyncDocuments(runtime: RuntimeInstance) {
return runtime.getSync().documents.list();
}
Contributing
CONTRIBUTING.md
file for more details.Code of Conduct
Contributors
Dominik Kundel 💻 📖 |
This project follows the all-contributors specification. Contributions of any kind welcome!
License
MIT
Metadata
- Unknown
- Whatever
- Twilio Inc.
- released 11/3/2021