actionhero/src/actions/cacheTest.ts

The reusable, scalable, and quick node.js API server for stateless and stateful applications

import { cache, Action } from "./../index";

export class CacheTest extends Action {
  constructor() {
    super();
    this.name = "cacheTest";
    this.description = "I will test the internal cache functions of the API";
    this.inputs = {
      key: {
        required: true,
        formatter: this.stringFormatter,
        validator: this.stringValidator,
      },

      value: {
        required: true,
        formatter: this.stringFormatter,
        validator: this.stringValidator,
      },
    };

    this.outputExample = {
      cacheTestResults: {
        saveResp: true,
        sizeResp: 1,
        loadResp: {
          key: "cacheTest_key",
          value: "value",
          expireTimestamp: 1420953274716,
          createdAt: 1420953269716,
          readAt: null,
        },
        deleteResp: true,
      },
    };
  }

  stringFormatter(s) {
    return String(s);
  }

  stringValidator(s) {
    if (s.length < 3) {
      return "inputs should be at least 3 letters long";
    } else {
      return true;
    }
  }

  async run({ params }: { params: { key: string; value: string } }) {
    const key = `cacheTest_${params.key}`;
    const value = params.value;

    return {
      cacheTestResults: {
        saveResp: await cache.save(key, value, 5000),
        sizeResp: await cache.size(),
        loadResp: await cache.load(key),
        deleteResp: await cache.destroy(key),
      },
    };
  }
}