@elfsquad/configurator

中文文档
3.6.20发布于 2026/11/02MITTypeScriptCommonJS构建来源已验证近 30 天下载 4299

Elfsquad 配置库允许您轻松与 配置 API。 。 。 .

中文使用文档

精灵配置图书馆

Elfsquad 配置库允许您轻松与 配置 API。 。 。 .

文档

可在以下网址查找文档: https://docs.elfsquad.io/docs/configurator/librarys/elfsquad-configurator-library 互联网档案馆的存檔,存档日期2013-12-02

实例

const TENANT_ID = 'ff0a9727-ced1-4b99-9f8a-2087a1f79ba4';

const configuratorContext = new ConfiguratorContext({
    tenantId: TENANT_ID
});

configuratorContext.getSettings().then((settings) => {
    console.log('settings', settings);
});

configuratorContext.getConfigurationModels().then((models) => {
    console.log('models', models);

    let model = models.features[0];
    
    configuratorContext.newConfiguration(model.name).then((configuration) => {
        console.log('newConfiguration', configuration);

        configuratorContext.openConfiguration(configuration.id).then((configuration) => {
            console.log('openedConfiguration', configuration);

            const feature = configuration.steps[0].features[0];
            
            configuration.updateRequirement(feature.id, true, 1).then((updateResult) => {
                console.log('updateResult', updateResult);
            });

            configuration.updateText(feature.id, 'test 123').then((updateResult) => {
                console.log('updateTextResult', updateResult);
            });

            // Optionally target a feature owned by a linked configuration by passing its id
            configuration.updateText(feature.id, 'test 123', linkedConfigurationId).then((updateResult) => {
                console.log('updateTextResult', updateResult);
            });

            configuration.changeLanguage(Object.keys(models.languages)[2]).then((updateResult) => {
                console.log('changeLanguage', updateResult);
            });

            configuration.getStepImage(configuration.steps[0].id).then((image) => {
                console.log('image', image);
            });

            configuration.getPdf().then((pdf) => {
                console.log('pdf', pdf);
            });

            configuratorContext.getLayout3d().then((layout) => {
                console.log('layout', layout);
            });
        });
    });
});

版本与发布记录

@elfsquad/configurator 共发布 50 个版本,首次发布于 2021/09/02;过去 12 个月发布了 33 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
3.6.20latest2026/11/0211 天前
3.6.192026/10/091 个月前
3.6.182026/10/061 个月前
3.6.172026/09/281 个月前
3.6.162026/09/241 个月前
3.6.152026/09/112 个月前

关于 @elfsquad/configurator 的常见问题

@elfsquad/configurator 是什么?

Elfsquad 配置库允许您轻松与 配置 API。 。 。 .

如何安装 @elfsquad/configurator?

在项目目录运行 npm install @elfsquad/configurator,或使用 pnpm add / yarn add / bun add。

@elfsquad/configurator 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@elfsquad/configurator 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@elfsquad/configurator 可以商用吗?

@elfsquad/configurator 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@elfsquad/configurator 的下载量有多少?

根据 npm 官方下载统计,@elfsquad/configurator 在 2026/10/14 – 2026/11/12 这 30 天内被下载 4,299 次,日均约 143 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@elfsquad/configurator 还在维护吗?

最新版本 3.6.20 发布于 2026/11/02(11 天前);至今共发布 50 个版本,其中过去 12 个月发布了 33 个;首次发布于 2021/09/02。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。