https://github.com/leancloud/typescript-sample-code
TypeScript SDK 文档中的示例代码
https://github.com/leancloud/typescript-sample-code
Last synced: 26 days ago
JSON representation
TypeScript SDK 文档中的示例代码
- Host: GitHub
- URL: https://github.com/leancloud/typescript-sample-code
- Owner: leancloud
- License: mit
- Created: 2016-06-08T00:42:02.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-11-08T01:38:15.000Z (over 9 years ago)
- Last Synced: 2025-10-26T19:02:58.373Z (5 months ago)
- Language: TypeScript
- Size: 41 KB
- Stars: 4
- Watchers: 19
- Forks: 1
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LeanCloud TypeScript SDK 文档示例代码
## 文档地址
[JavaScript & TypeScript 数据存储开发指南](https://leancloud.cn/docs/leanstorage_guide-js.html)
## 功能
当开发者阅读文档的代码片段，想要阅读更多关于执行代码片段使用的前置条件时，可以阅读本项目里面一一对应的代码片段的测试用例，这样可以方便开发者使用接口的时候有一个最佳实践的参考。
## 贡献代码
从文档中找到对应代码片段的 Test Case 的源代码，修改，然后发出 PR，主分支(master)会有 travis CI 的脚本自动运行单元测试，只有测试全都通过才可以被合并到主分支，而文档对应的地方也应该即使修改。
## 代码示例
代码示例请参考根目录下的：[code-example](code-example.ts)
```typescript
///
import * as chai from 'chai';
import * as AV from 'leancloud-storage';
// 测试用例所需要的前置条件都需要在启动的时候调用，例如
/*
AV.init({
appId:'{put-test-appId-here}}',
appKey:'{put-test-appKey-here}'});
*/
// 或者有一些需要提前写入的测试数据，例如用户修改密码等操作，需要的前置条件是用户已经存在
// 因此，也需要在脚本加载的时候就执行
// 还可以定义一些占位符变量，例如测试用例要用到的 objectId 等重要数据
/*
let targetObjectId = '';
let file = ...
*/
// category-name 可以是 Object，File 等功能模块的首字母大写
describe('sample-category-name', function () {
// 测试用例所需要的前置条件都需要在启动的时候调用。
// 在 before 函数里面执行一些欲置脚本
// 例如初始化 LeanCloud SDK
before(function() {
// runs before all tests in this block
/*
AV.init({
appId:'{put-test-appId-here}}',
appKey:'{put-test-appKey-here}'});
*/
});
// 实例方法使用 # 分隔类和方法
it('ClassName#instance-function-name', function (done) {
try{
// 示例代码-Start
// 示例代码-End
done();
}
catch(e){
chai.assert.isNull(e);
}
});
//静态方法使用 .(dot) 分隔类和方法
it('ClassName.static-function-name', function (done) {
try{
// 示例代码-Start
// 示例代码-End
done();
}
catch(e){
chai.assert.isNull(e);
}
});
// 在 after 里面可以执行一些清理脚本，清理本次执行所产生的脏数据
after(function() {
// runs after all tests in this block
});
});
```
## Travis CI 配置
因为网络原因，如果在服务端使用大陆节点的 AppID 以及 AppKey 偶尔会 Https 请求超时，单元测试的断言会误判。因此在 Travis CI 运行的时候动态修改了环境变量，使用了美国节点的应用。但是并没有直接书写在 `.travis.yml` 里，而是在服务端的配置里面。
## FAQ
Q：SDK 更新会对当前项目产生影响么？
A：会，目前 JS SDK 每一次有新的 PR 被 merge 进主分支，都会发送一个 PR 到当前项目，这个 PR 只会更新 `package.json` 里面的 JS SDK 的版本，这样也会触发 travis CI 进行自动化检测，一旦 `npm test` 结果没有通过，会及时通知文档维护人员进行查看，需要手动的去比对文档中的代码，这样可以避免过期方法或者接口更名对用户造成的困扰。