Skip to content
This repository was archived by the owner on Feb 8, 2024. It is now read-only.

Commit 834a595

Browse files
committed
Add docs for isCreateRestInstance function
1 parent 44a9019 commit 834a595

2 files changed

Lines changed: 11 additions & 1 deletion

File tree

lib/index.js

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,14 @@ import { createRestInstanceSymbol } from './symbol'
2727
* }
2828
*/
2929

30-
export const isCreateRestInstance = routing => routing[createRestInstanceSymbol] === true
30+
/**
31+
* Check is correct routes passed
32+
* @public
33+
* @function
34+
* @param {RestRoutes} routes
35+
* @return {boolean}
36+
*/
37+
export const isCreateRestInstance = routes => routes[createRestInstanceSymbol] === true
3138

3239
/**
3340
* @desc Routes object

lib/symbol.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1+
/**
2+
* @private
3+
*/
14
export const createRestInstanceSymbol = Symbol('createRestInstance')

0 commit comments

Comments
 (0)