Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

grays

baboon-king17MIT0.0.5TypeScript support: included

Turn your site gray and automatically cancel it at a certain time

gray, grays, salute, respect

readme

grays

Turn your site gray and automatically cancel it at a certain time

Instal

pnpm i grays

#or

npm i grays

#or

yarn add grays

Basic Used

import { grays } from "grays";

grays();

Custom Graysale

import { grays } from "grays";

grays("html", 60);

Immediate (Default behavior)

import { grays } from "grays";

grays("html", 99, {
  immediate: true,
});

Automatic expiration on Immediate

import { grays } from "grays";

grays("html", 99, {
  expire: new Date(2022, 11, 1).getTime() // Expires automatically after "2022-12-1
  immediate: true,
});

Custom ClassName

import { grays } from "grays";

grays("html", 99, {
  className: "grays-for",
});

API

import { grays } from "grays";

const { cancel, apply } = grays();