https://github.com/saqqdy/untiljs
Promised one-time watch for changes
https://github.com/saqqdy/untiljs
until until-done untiljs use-until useuntil
Last synced: 5 months ago
JSON representation
Promised one-time watch for changes
- Host: GitHub
- URL: https://github.com/saqqdy/untiljs
- Owner: saqqdy
- License: mit
- Created: 2024-08-12T08:48:50.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-28T06:36:20.000Z (11 months ago)
- Last Synced: 2024-10-29T09:06:16.146Z (11 months ago)
- Topics: until, until-done, untiljs, use-until, useuntil
- Language: TypeScript
- Homepage:
- Size: 737 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README-zh_CN.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# untiljs
Promise观察一次性变化
[![NPM version][npm-image]][npm-url]
[![Codacy Badge][codacy-image]][codacy-url]
[![tree shaking][tree-shaking-image]][tree-shaking-url]
![typescript][typescript-url]
[![Test coverage][codecov-image]][codecov-url]
[![npm download][download-image]][download-url]
[![gzip][gzip-image]][gzip-url]
[![License][license-image]][license-url]
[![Sonar][sonar-image]][sonar-url]
### **[API 文档](https://www.saqqdy.com/untiljs)** • **[更新日志](./CHANGELOG.md)**
**使用其他语言阅读：[English](./README.md) | 简体中文**
## 体验
在线体验 untiljs 功能 [Edit in CodeSandbox](https://codesandbox.io/p/sandbox/github/saqqdy/untiljs/tree/master/examples)
## 安装
```bash
# 使用pnpm
$ pnpm install untiljs
# 使用npm
$ npm install untiljs --save
# 使用 yarn
$ yarn add untiljs
```
## 使用
### 1. 等待异步数据加载完成
```ts
import { ref } from 'vue'
import until from 'untiljs'
const val = ref(1)
setTimeout(() => {
val.value = 2
}, 1000)
;(async () => {
await until(val).toBe(2)
// state is now ready
})()
```
### 2. 自定义表达式
```ts
import { ref } from 'vue'
import until from 'untiljs'
const val = ref(1)
setTimeout(() => {
val.value = 2
}, 1000)
;(async () => {
await until(val).toMatch(value => value > 1)
// state is now ready
})()
```
### 3. 等待直到超时
```ts
import { ref } from 'vue'
import until from 'untiljs'
const val = ref(1)
setTimeout(() => {
val.value = 2
}, 1000)
;(async () => {
await until(val).not.toBe(ref(2), { timeout: 500, throwOnTimeout: true })
// reject timeout
})()
```
### 4. 更多示例
```ts
import { ref } from 'vue'
import until from 'untiljs'
const val = ref(1)
setTimeout(() => {
val.value = 2
}, 1000)
;(async () => {
await until(ref).toBe(true)
await until(ref).toMatch(v => v > 5 && v < 10)
await until(ref).changed()
await until(ref).changedTimes(2)
await until(ref).toBeTruthy()
await until(ref).toBeNull()
await until(ref).not.toBeNull()
await until(ref).not.toBeTruthy()
})()
```
## 使用 unpkg CDN
```html
await until(val).toBe(true)
// ...
```
## 问题和支持
Please open an issue [here](https://github.com/saqqdy/untiljs/issues).
## License
[MIT](LICENSE)
[npm-image]: https://img.shields.io/npm/v/untiljs.svg?style=flat-square
[npm-url]: https://npmjs.org/package/untiljs
[codacy-image]: https://app.codacy.com/project/badge/Grade/f70d4880e4ad4f40aa970eb9ee9d0696
[codacy-url]: https://www.codacy.com/gh/saqqdy/untiljs/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saqqdy/untiljs&utm_campaign=Badge_Grade
[tree-shaking-image]: https://badgen.net/bundlephobia/tree-shaking/untiljs
[tree-shaking-url]: https://bundlephobia.com/package/untiljs
[typescript-url]: https://badgen.net/badge/icon/typescript?icon=typescript&label
[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/untiljs.svg?style=flat-square
[codecov-url]: https://codecov.io/github/saqqdy/untiljs?branch=master
[download-image]: https://img.shields.io/npm/dm/untiljs.svg?style=flat-square
[download-url]: https://npmjs.org/package/untiljs
[gzip-image]: http://img.badgesize.io/https://unpkg.com/untiljs/dist/index.min.js?compression=gzip&label=gzip%20size:%20JS
[gzip-url]: http://img.badgesize.io/https://unpkg.com/untiljs/dist/index.min.js?compression=gzip&label=gzip%20size:%20JS
[license-image]: https://img.shields.io/badge/License-MIT-blue.svg
[license-url]: LICENSE
[sonar-image]: https://sonarcloud.io/api/project_badges/quality_gate?project=saqqdy_untiljs
[sonar-url]: https://sonarcloud.io/dashboard?id=saqqdy_untiljs