舟山房屋模拟数据包 (zhoushan-house-mock-data)

提供房屋结构、墙体、门窗等数据的 Promise API

安装

npm install zhoushan-house-mock-data

使用方法

ES6 模块

import { getHouseData, getHouseDataSync, getHouseDataWithDelay, IZHouseProtocol } from 'zhoushan-house-mock-data';

// 使用 Promise 获取数据
getHouseData().then((data: IZHouseProtocol) => {
    console.log(data);
});

// 使用 async/await
async function fetchData() {
    const data = await getHouseData();
    console.log(data);
}

// 同步获取数据
const data = getHouseDataSync();

// 延迟获取数据（模拟网络请求）
getHouseDataWithDelay(1000).then((data) => {
    console.log(data);
});

CommonJS

const { getHouseData, getHouseDataSync } = require('zhoushan-house-mock-data');

getHouseData().then(data => {
    console.log(data);
});

数据结构

interface IZHouseProtocol {
    name: string;           // 房屋名称
    communityName: string;  // 小区名称
    city: string;          // 城市
    province: string;      // 省份
    rooms: IRoom[];        // 房间列表
    walls: IWall[];        // 墙体列表
    holes: IHole[];        // 门窗洞口列表
    pillars: IPillar[];    // 柱子列表
    flues: IFlue[];        // 烟道列表
    beams: IBeam[];        // 梁列表
    placeHolders: IPlaceHolder[]; // 占位符列表（开关、插座等）
}

API 说明

| 函数名 | 返回值 | 说明 | |--------|--------|------| | getHouseData() | Promise<IZHouseProtocol> | Promise 方式获取数据 | | getHouseDataSync() | IZHouseProtocol | 同步获取数据 | | getHouseDataWithDelay(delay) | Promise<IZHouseProtocol> | 延迟获取数据 |

开发

# 安装依赖
npm install

# 构建
npm run build

# 启动服务
npm start

# 发布到 npm
npm publish

License

MIT