serverless-aws-lambda/resources/offline.md

AWS Application Load Balancer and API Gateway - Lambda dev tool for Serverless. Allows Express synthax in handlers. Supports packaging, local invoking and offline ALB, APG, S3, SNS, SQS, DynamoDB Stream server mocking.

Set offline static path, custom port and add request listeners:

```js
// config.js
import { defineConfig } from "serverless-aws-lambda/defineConfig";

export default defineConfig({
  esbuild: {
    //...
  },
  offline: {
    staticPath: "./public",
    port: 9999,
    onReady: (port) => {
      console.log("We are ready to listen on", port);
    },
    request: [
      {
        filter: /^\/__routes(\/)?$/, // filters request when request URL match /__routes
        callback: (req, res) => {
          // node http request Incoming Message and Response object
          res.statusCode = 404;
          res.end(`${req.url} not found`);
        },
      },
    ],
  },
});
```

### virtualEnvs

serverless-aws-lambda adds `virtualEnvs` object support to your serverless.yml.
values which can be accessed only in your custom config lambda function.  
An example:

```yaml
# serverless.yml
service: myapp

frameworkVersion: "3"
configValidationMode: error

plugins:
  - serverless-aws-lambda

custom:
  virtualEnvs:
    S3_BUCKET: mybucket # default bucket name
  serverless-aws-lambda:
    port: 3000
    watch: true
    configPath: ./config.default

functions:
  players:
    handler: src/api/routes/players.default
    virtualEnvs:
      S3_BUCKET: myPlayersPhotoBucket # bucket name for this lambda
    events:
      - alb:
          listenerArn: arn:aws:elasticloadbalancing:eu-west-3:0000000000000:listener/app/myAlb/11111111111111/2222222222222
          priority: 457
          conditions:
            path: "/v1/players"
            method: ["GET", "DELETE"]
```

```js
import { defineConfig } from "serverless-aws-lambda/defineConfig";

export default defineConfig({
  esbuild: {
    // ...
  },
  offline: {
    // ...
  },
  buildCallback: async (result) => {
    const foundLambda = lambdas.find((x) => x.name == "players");

    if (foundLambda) {
      console.log(foundLambda.virtualEnvs);
    }
  },
});
```

## Run serverless-aws-lambda programmatically

```js
import { Server } from "serverless-aws-lambda/server";

const server = new Server({
  stage: "dev",
  port: 9999,
  watch: true,
  debug: true,
  onRebuild: async () => {
    await doSomething();
  },
});

const { port, ip } = await server.start();

// do something
// then
// kill it
server.stop();
```