@ eik/ 常见

这个软件包包含其他Eik模块中使用的通用公用事业和计划.

司马

这个 计划 eik.json 可见于此 repo。 这就是你如何用在你的身上 eik.json。 。 。 .

{
    "$schema": "https://raw.githubusercontent.com/eik-lib/common/main/lib/schemas/eikjson.schema.json",
    "name": "my-app",
    "version": "1.0.0",
    "server": "https://eik.store.com",
    "files": "./public",
    "import-map": ["https://eik.store.com/map/store/v1"]
}

@eik/common 拥有 JavaScript API 到 对照计划检查。 。 。 .

API 密码

帮助者

helpers 拥有其它几个Eik模块使用的公用功能.

import { helpers } from "@eik/common";

let config = helpers.getDefaults();

这些职能是: helpers。 。 。 .

本地资产

为地方发展设置资产通道. 已挂载的路径匹配 Eik 服务器上的路径, 并且从 eik. json 工程文件中读取值 .

鉴于这个服务器 eik.json,在您的应用程序中将添加以下路径 .

import { helpers } from "@eik/common";
import express from "express";

let app = express();

await helpers.localAssets(app);

{
    "name": "my-app",
    "version": "1.0.0",
    "server": "https://eik.store.com",
    "files": {
        "esm.js": "./assets/esm.js",
        "esm.css": "./assets/esm.css",
        "/": "./assets/**/*.map"
    }
}

/pkg/my-app/1.0.0/esm.js
/pkg/my-app/1.0.0/esm.css
/pkg/my-app/1.0.0/esm.js.map
/pkg/my-app/1.0.0/esm.css.map

计划

schemas 具有对照 eik.json 计划。 。 。 . 您可以检查图中的值 eik.json 个人或个人 中数值.

import { schemas } from "@eik/common";

let { error, value } = schemas.validate.eikJSON(eikConfig);
if (error) {
    // fallback
}

如果你喜欢,你可以使用 assert API 显示错误 .

import { schemas } from "@eik/common";

try {
    schemas.assert.eikJSON(eikConfig);
} catch {
    // fallback
}

这些职能是: schemas.validate 财务报告和审定财务报表 schemas.assert。 。 。 .

流线

stream 具有检查一个值是否为流函数.

import { stream } from "@eik/common";

if (stream.isStream(maybeStream)) {
    // yup, it's a Stream
}

if (stream.isReadableStream(maybeReadableStream)) {
    // yup, it's a ReadableStream
}

验证符

validators 函数返回已规范化的字符串为小写,或者如果值没有通过验证规则,则丢出错误. 在可能的情况下,最好使用 schemas API 密码。 。 。 .

import { validators } from "@eik/common";

let alias = validators.alias("1");

这些职能是: validators。 。 。 .