# qml

> ----

Latest version **0.0.0** (published 2018-02-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install qml
pnpm add qml
yarn add qml
bun add qml
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.0 |
| Published | 2018-02-20 |
| First published | 2018-02-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 23.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | houzhanfeng |

## Links

- npm: https://www.npmjs.com/package/qml
- npm.io page: https://npm.io/package/qml

## Dependencies (5)

- [mota](https://npm.io/package/mota.md) ^0.4.7
- [debug](https://npm.io/package/debug.md) ^3.1.0
- [ntils](https://npm.io/package/ntils.md) ^4.0.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.10.0
- [require-dir](https://npm.io/package/require-dir.md) ^1.0.0

## Recent versions

- 0.0.0 (latest) — 2018-02-20

## README

# YamlQL 
----

#### 1. 普通查询
```yml
user: 
  - getUser: id
```

返回
```json
{
  "user": {
    "userId": "user1",
    "userName": "bob",
    "userAge": 30,
    "userGender": "male"
  }
}
```

#### 2. 声明要返回的字段
```yml
user: 
  - getUser: id
  - mapping:
      name: userName
      age: userAge
```

返回
```json
{
  "user": {
    "name": "bob",
    "age": 30
  }
}
```

也可以只声明返回字段，但不进行映射
```yml
user: 
  - getUser: id
  - fileds: 
      - userName
      - userAge
```

#### 3. 查询列表
```yml
userList: 
  - getUsers
  - items:
      name: userName
      age: userAge
```

返回

```json
{
  "userList": [
    {...},
    {...}
  ]
}
```


#### 4. 子查询

```yml
user: 
  - getUser(id)
  - id: userId
    name: userName
    age: userAge
    roles: 
      - getRoles: id
      - items
        - name: roleName
          id: roleId
```

返回
```json
{
  "user": {
    "name": "bob",
    "age": 30,
    "roles": [
      {
        "name": "角色一",
        "id": "role1"
      },
      {
        "name": "角色二",
        "id": "role2"
      }
    ]
  }
}
```

---
_Source: https://npm.io/package/qml · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._