Document the possible types for the search function

[binarykitchen]

In your Readme the search function also has the parameter type:
https://github.com/tksventures/pimbridge#searchresource-params-typelist-callback

But it's not documented. What it is for and which one types are supported? Thx

[MikeLuDev]

@rafaeloaguirre I believe that you can answer this.

[rafaeloaguirre]

@binarykitchen Hello. Thank you for your inquiry. Currently, type can be 'list' or 'count'. The first type returns the ids and types of the resources that match the parameters provided while the second one return the number of resources matching them. The count function in the package is basically an alias of the search function with 'count' parameter.
As work in the package continues, we will likely expand the types associated with the search function and update our documentation to provide more details.

[binarykitchen]

Sweet as, do that and update documentation.

[michalmikolajczyk]

moving this to our backlog thanks for your feedback @binarykitchen