3.0.0 ā€¢ Published 3 years ago

@gian2705/parse-hooks v3.0.0

Weekly downloads
3
License
MIT
Repository
github
Last release
3 years ago

Custom react hooks for Parse Server services. It turns parse queries into hooks to extract component logic into reusable functions. Inspired by Custom useFetch()

šŸ  Homepage

Install

yarn install @gian2705/parse-hooks

Usage

This package assumes Parse is used as a backend service and is already initialized.

useQuery

This is a normal Parse.Query implementation which accepts a query, limit and skip and returns the query results, errors if any, object count and isLoading values

ParametersTypeDescription
queryObject<Parse.Query>A query for the needed data
limitIntlimit as used in Parse.Query
skipIntskip as used in Parse

Response :

{
    response, //Array<ParseObject>
    error, //Instance of  Parse.Error
    isLoading, //Boolean
    count, //int
}

useSearch

A special Parse.Query implementation capable of searching the defined fields for the given keyword, It works using the Parse.Query.or implementation. The search fields can also be nested as for nested ParseObjects.

ParametersTypeDescription
queryObject<Parse.Query>A query for the needed data
limitIntlimit as used in Parse.Query
skipIntskip as used in Parse.Query
searchFieldsArrayA list of fields to search the keyword from. (See examples on how to work with nested Parse.Objects)
keywordStringThe specified keyword to be searched
classNameArrayThe class name of the Parse.Object to perform the query on

Response :

{
    response, //Array<ParseObject>
    error, //Instance of  Parse.Error
    isLoading, //Boolean
    count, //int
}

useFilter

A special Parse.Query implementation capable of filtering the defined query using the provided filters, It works using the Parse.Query.containedIn implementation. It currently does not work for nested objects (Still a work in progress)

ParametersTypeDescription
queryObject<Parse.Query>A query for the needed data
limitIntlimit as used in Parse.Query
skipIntskip as used in Parse.Query
filtersArray<Object>An array of filters to be implemented (See examples)

useCount

Implements the Parse.Query count method and returns object count as the response.

ParametersTypeDescription
queryObject<Parse.Query>A query for the needed data

Response :

{
    response, //Array<ParseObject>
    error, //Instance of  Parse.Error
    isLoading, //Boolean
}

useAll

Combines useSearch, useFilter, and useQuery in one hook. Currently only one hook can work at a time. useSearch is triggered by the existence of the keyword, useFilter is triggered by existence of filters. useQuery works when there is neither keyword nor filters.

ParametersTypeDescription
queryObject<Parse.Query>A query for the needed data
limitIntlimit as used in Parse.Query
skipIntskip as used in Parse.Query
searchFieldsArrayA list of fields to search the keyword from. (See examples on how to work with nested Parse.Objects)
keywordStringThe specified keyword to be searched
classNameStringThe class name of the Parse.Object to perform the query on
filtersArray<Object>An array of filters to be implemented

Response :

{
    response, //Array<ParseObject>
    error, //Instance of  Parse.Error
    isLoading, //Boolean
    count, //int
}

Visit the examples folder to see how you can use the hooks

Author

šŸ‘¤ Gift Nnko

šŸ¤ Contributing

Contributions, issues and feature requests are welcome!Feel free to check issues page.

Show your support

Give a ā­ļø if this project helped you!

šŸ“ License

Copyright Ā© 2020 Gift Nnko. This project is MIT licensed.


This README was generated with ā¤ļø by readme-md-generator

3.0.0

3 years ago

2.1.0

3 years ago

2.0.2

4 years ago

2.0.1

4 years ago

2.0.0

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago