psmattas/resolver
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add FileAPI, PostAPI doc

Browse Source
This commit is contained in:
Qolzam
2017-07-17 15:47:04 +04:30
parent 3e387a9747
commit cb563384e6
2 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/layers/api.md
View File

@@ -16,4 +16,12 @@ To get circles which the user is added in. `circles` is the parameter that we wa
getFollowingUsers = (circles) => {} getFollowingUsers = (circles) => {}
``` ```
Get the user who are in circles. `circles` is the paramater that we get users from. Get the user who are in circles. `circles` is the paramater that we get users from.
## FileAPI.jsx
A set of functions for working with files.
## PostAPI.jsx
A set of functions for working with user posts.

2
docs/layers/tests.md
View File

@@ -1,6 +1,6 @@
# Tests # Tests
This layer is responsible to test each layer of application. Each test file name follow `[file-name].test.jsx` pattern for naming. We use [expect](https://github.com/mjackson/expect) to write assertion for each test case. We use [Karma](https://karma-runner.github.io/1.0/index.html) to run our tests. We use [Mocha](https://mochajs.org/) that tests run serially, allowing for flexible and accurate reporting, while mapping uncaught exceptions to the correct test cases. This layer is responsible to test each layer of application. Each test file name follow `[file-name].test.jsx` pattern for naming. We use [expect](https://github.com/mjackson/expect) to write assertion for each test case. We use [Karma](https://karma-runner.github.io/1.0/index.html) to run our tests. We use [Mocha](https://mochajs.org/) which tests run serially, allowing for flexible and accurate reporting, while mapping uncaught exceptions to the correct test cases.
## Test Actions ## Test Actions