escss-estest

Language

• 中文

Quick Links

• What is ESCSS-ESTest?
• Core Concept - Water Filter
• Usage
• Installation
• License

What is ESCSS-ESTest?

ESCSS-ESTest helps you to achieve 100% coverage by taking the potential of TDD and TypeScript.

Core Concept - Water Filter

function foo() {
  {
    // unhappy path(throw error)
  }

  // happy path
}

Usage

Use Cases

ESTest(NaN, "NaN"); // new
ESTest([], "array"); // new
ESTest(null, "null"); // new
ESTest(undefined, "undefined"); // new
ESTest(1, "number");
ESTest("foo", "string");
ESTest(true, "boolean");
ESTest({}, "object");
ESTest(1n, "bigint");
ESTest(Symbol(), "symbol");
ESTest(function () {}, "function");
ESTest(1, "object"); // error
ESTest(1, "object", "foo"); // error message

Pure vs Impure

import { ESTest } from "escss-estest";
let isEnable = true;

// Pure (input in {...})
function pureSum(a, b) {
  {
    ESTest(a, "number");
    ESTest(b, "number");
    ESTest(isEnable, "boolean");
  }

  if (!isEnable) return 0;

  return a + b;
}

// Impure
function impureSum(a, b) {
  if (!isEnable) return 0;

  return a + b;
}

// NOTE: the "function" type check is unnecessary.
function total(x) {
  {
    ESTest(x, "number");

    // If the function doesn't exist, it will return 'xxx is undefined.'
    // If the function exists, pureSum(a, b) will handle type check, so the "function" check is redundant.
    ESTest(pureSum, "function"); // not necessary.
  }

  return x + pureSum(1, 2);
}

Error handling: async/await

import { ESTest } from "escss-estest";

async function getData() {
  const url = "https://jsonplaceholder.typicode.com/todos/99999"; // undefined api
  const response = await fetch(url);
  const json = await response.json();

  {
    ESTest(json, 'object')
    ESTest(json.userId, "number");
    ESTest(json.id, "number");
    ESTest(json.title, "string");
    ESTest(json.completed, "boolean");
  }

  console.log(json);
}

getData(); // get error (undefined api from 99999)

Error handling: class

import { ESTest } from "escss-estest";

class Animal {
  constructor(name, age) {
    {
      ESTest(name, "string");
      ESTest(age, "number");
    }

    this.name = name;
    this.age = age;
  }
}

new Animal("cat", "10"); // get error, "10" should be number

Installation

  # Using npm
  npm add escss-estest

  # Using yarn
  yarn add escss-estest

  # Using pnpm
  pnpm add escss-estest

  # Using bun
  bun add escss-estest

  # Nuxt 3
  npx nuxi module add nuxt-escss-estest

License

see