alexa-ts
npm i alexa-ts
Deprecated!
No longer supported, please use ask-sdk instead

alexa-ts

A lightweight framework for building Alexa skills.

by o2Labs

3.0.0 (see all)License:MITTypeScript:Built-In
npm i alexa-ts
Readme

A lightweight framework for building Alexa skills. Build Status

Hello World

import * as Alexa from 'alexa-ts'

export const handler = Alexa.Lambda.pipe([
  Alexa.Pipe.router({
    InitialState: null,
    Launch: () => ({
      Say: { Text: 'Hello world' },
    }),
    Standard: {
      Help: () => ({
        Say: { Text: 'Try saying "hello"' },
      }),
    },
    Custom: [
      ["HelloWorldIntent", (state, slots) => ({
        Say: { Text: 'Hello world' },
      })]
    ]
  }),
  () => // Unhandled requests
    Alexa.response({
      Say: { Text: 'Sorry, I didn\'t understand.' },
    }),
])

More Examples

Features

Typed-checked state management

When using the router component, the state used in all handlers must be of the same type.

Normally you'd want to specify the type of the state when creating the routes object:

You must also specify an initial state which is a constant value, which will be used whenever a new session is initiated. This is the only required field in the routing table.

class CustomStateType {
  // Some fields etc
}

const routes: Alexa.Routes<CustomStateType> = {
  InitialState: new CustomStateType(),
}

Piping

Compose your Alexa application out of smaller compoents which can be chained together into an execution pipeline using Alexa.Lambda.pipe(steps), or use Pipe.join(steps) to just create a new pipe out of other pipe sections.

Examples of where this might be used are:

  • Logging all requests and responses to your skill.
  • Checking if account linking has been set up before executing the router.

Each pipe step is a function which is given the incoming request and a callback to execute the next step in the chain. The step must return a response (or throw an exception).

When calling the next you must pass the request. This allows steps in the chain to modify the original message for subsequent steps. You can also intercept the result of the next step before you can choose to return it, however, each step might return either a ResponseBody object, or a promise of the same type.

Note: In the special case of the SessionEnded handler, void is returned. All other handlers must return a response.

Promise Support

All of the IntentHandler, Handler and Pipe types can return either a value or a promise to return these values.

Here's an example of returning asynchronously within a handler.

export const handler = Alexa.Lambda.handler(() =>
  getMessageAsync()
  .then(message =>
    Alexa.response({
      Say: { Text: message },
    })
  )
)

Building & Publishing

Helpful commands:

  • Install Packages: yarn
  • Publish: npm publish
  • Build & Test: yarn prepare

Downloads/wk

6

GitHub Stars

27

LAST COMMIT

2yrs ago

MAINTAINERS

3

CONTRIBUTORS

2

OPEN ISSUES

0

OPEN PRs

5
VersionTagPublished
3.0.0
latest
5yrs ago
No alternatives found
No tutorials found
Add a tutorial