From 7a56ba0a8063d2651f9e9c1f44bd4a039667443e Mon Sep 17 00:00:00 2001 From: Qolzam Date: Sun, 16 Jul 2017 12:08:43 +0430 Subject: [PATCH] Add description for api --- docs/layers/api.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/layers/api.md b/docs/layers/api.md index e753d46..cfd3447 100644 --- a/docs/layers/api.md +++ b/docs/layers/api.md @@ -1,3 +1,19 @@ # API Is a decoupled layer of interfaces to data and/or functionality of one or more components. + +## CircleAPI.jsx + +We provided some functions for doing some procedures on user circles. + +```javascript +getUserBelongCircles = (circles,followingId) => {} +``` + +To get circles which the user is added in. `circles` is the parameter that we want to know if user is exist in any of them or not. `followingId` is the parameter that show the use identifier who we are looking for in `circles` parameter. + +```javascript +getFollowingUsers = (circles) => {} +``` + +Get the user who are in circles. `circles` is the paramater that we get users from. \ No newline at end of file