home.md

@@ -41,3 +41,28 @@
     3. sort - 排序
     4. skip - 忽略多少条记录，用于mongo数据库查询分页时，返回指定页的数据时使用，比如页面大小limit=10，需要第三页时skip为20
   * isLogin(me: Me) - 当前用户是否已经登录
+
+# DBService
+```javascript
+/**
+ * return entity given id
+ * @param entityType 
+ * @param id 
+ * @param fieldsToKeep 
+ * @param me 
+ * @param useCache 
+ * @param context 
+ */
+export function getEntityById(entityType: string, id: string, fieldsToHide: string[], fieldsToKeep: string[], context: Context, useCache: boolean = true, runHook: boolean = false): object 
+
+/**
+ * Return single entity from given query. query here represents a regular mongo search query object
+ * @param query 
+ * @param fields 
+ * @param me 
+ * @param context 
+ */
+export function getSingleEntity(entityType: string, query: any, fieldsToHide: string[], fieldsToKeep: string[], context: Context, runHook: boolean = false): object | null 
+
+
+```
\ No newline at end of file