Merge pull request #12 from YsnKsy/use-hooks-simplified

feat(src/index): concat 2 hooks into one useLocationSettings()

Author: YsnKsy

README.md

@@ -31,25 +31,28 @@ yarn add react-native-location-settings-enabler
 ```js
 import LocationSettingsEnabler from "react-native-location-settings-enabler"
 
-const { PRIORITIES, useCheckSettings, requestResolutionSettings } = LocationSettingsEnabler
-const { HIGH_ACCURACY } = PRIORITIES
-
-// Define configuration
-const config = {
-  priority: HIGH_ACCURACY, // default BALANCED_POWER_ACCURACY
-  alwaysShow: true, // default false
-  needBle: false, // default false
-}
-
-const req = () => requestResolutionSettings(config)
+const {
+  PRIORITIES: { HIGH_ACCURACY },
+  useLocationSettings,
+} = LocationSettingsEnabler
 
-// React Native App Component
+// React Component
 const App = () => {
-  // use hook to check location status
-  const enabled = useCheckSettings(config)
+  const [enabled, requestResolution] = useLocationSettings(
+    {
+      priority: HIGH_ACCURACY, // default BALANCED_POWER_ACCURACY
+      alwaysShow: true, // default false
+      needBle: true, // default false
+    },
+    false /* optional: default undefined */,
+  )
 
   return (
-    <View>{!enabled && <Button onPress={req} title="Request Resolution Location Settings" />}</View>
+    <View>
+      {!enabled && (
+        <Button onPress={requestResolution} title="Request Resolution Location Settings" />
+      )}
+    </View>
   )
 }
 ```
@@ -61,8 +64,11 @@ const App = () => {
 ```js
 import LocationSettingsEnabler from "react-native-location-settings-enabler"
 
-const { PRIORITIES, checkSettings, requestResolutionSettings } = LocationSettingsEnabler
-const { HIGH_ACCURACY } = PRIORITIES
+const {
+  PRIORITIES: { HIGH_ACCURACY },
+  checkSettings,
+  requestResolutionSettings
+} = LocationSettingsEnabler
 
 // Adds a listener to be invoked when location settings checked using
 // [checkSettings] or changed using [requestResolutionSettings]
@@ -141,45 +147,31 @@ Static object contain a list quality of service for location updates. If your ap
 
 ### Methods
 
-> ### `useCheckSettings({ priority, alwaysShow, needBle }, initialSatus?)`
+> ### `useLocationSettings({ priority, alwaysShow, needBle }, initialStatus?)`
 
 ```js
 import LocationSettingsEnabler from "react-native-location-settings-enabler"
 
-const { useCheckSettings, PRIORITIES } = LocationSettingsEnabler
-const { HIGH_ACCURACY } = PRIORITIES
+const {
+  useLocationSettings,
+  PRIORITIES: { HIGH_ACCURACY },
+} = LocationSettingsEnabler
 
-const enabled = useCheckSettings({
+const [enabled, requestResolution] = useLocationSettings({
   priority: HIGH_ACCURACY, // optional: default BALANCED_POWER_ACCURACY
   alwaysShow: true, // optional: default false
   needBle: true, // optional: default false
 })
 
 console.log(`Location are ${enabled ? "enabled" : "disabled"}`)
-```
-
-Hook let you check if the user's device location is turned off / on.
-
----
 
-> ### `useRequestResolutionSettings({ priority, alwaysShow, needBle }, initialSatus?)`
-
-```js
-import LocationSettingsEnabler from "react-native-location-settings-enabler"
-
-const { useRequestResolutionSettings, PRIORITIES } = LocationSettingsEnabler
-const { HIGH_ACCURACY } = PRIORITIES
-
-const enabled = useRequestResolutionSettings({
-  priority: HIGH_ACCURACY, // optional: default BALANCED_POWER_ACCURACY
-  alwaysShow: true, // optional: default false
-  needBle: true, // optional: default false
-})
-
-console.log(`Location are ${enabled ? "enabled" : "disabled"}`)
+// ...
+if (!enabled) {
+  requestResolution()
+}
 ```
 
-Hooks let display an activity where the user's can turn location 'on', only if location is already turned 'off'.
+Hook let you check the user's device location status 'on' / 'off' and method let you display an activity where they can turn location 'on'.
 
 ---
 
@@ -188,8 +180,10 @@ Hooks let display an activity where the user's can turn location 'on', only if l
 ```js
 import LocationSettingsEnabler from "react-native-location-settings-enabler"
 
-const { checkSettings, PRIORITIES } = LocationSettingsEnabler
-const { HIGH_ACCURACY } = PRIORITIES
+const {
+  checkSettings,
+  PRIORITIES: { HIGH_ACCURACY },
+} = LocationSettingsEnabler
 
 checkSettings({
   priority: HIGH_ACCURACY, // optional: default BALANCED_POWER_ACCURACY
@@ -207,8 +201,10 @@ Checking if the user's device location is turned on / off.
 ```js
 import LocationSettingsEnabler from "react-native-location-settings-enabler"
 
-const { requestResolutionSettings, PRIORITIES } = LocationSettingsEnabler
-const { HIGH_ACCURACY } = PRIORITIES
+const {
+  requestResolutionSettings,
+  PRIORITIES: { HIGH_ACCURACY },
+} = LocationSettingsEnabler
 
 requestResolutionSettings({
   priority: HIGH_ACCURACY, // optional: default BALANCED_POWER_ACCURACY

example/src/App.tsx

@@ -2,14 +2,10 @@ import * as React from "react"
 import { StyleSheet, View, Text, Button } from "react-native"
 import LocationSettingsEnabler from "react-native-location-settings-enabler"
 
-const { PRIORITIES, useCheckSettings, requestResolutionSettings } = LocationSettingsEnabler
-const { HIGH_ACCURACY } = PRIORITIES
-
-const config = {
-  priority: HIGH_ACCURACY,
-  alwaysShow: true,
-  needBle: true,
-}
+const {
+  PRIORITIES: { HIGH_ACCURACY },
+  useLocationSettings,
+} = LocationSettingsEnabler
 
 const LocationStatus = (props: { enabled: boolean | undefined }) => (
   <Text style={styles.status}>
@@ -29,10 +25,12 @@ const RequestResolutionSettingsBtn = (props: { onPress: any }) => (
   <Button color="red" title="Request Resolution Location Settings" onPress={props.onPress} />
 )
 
-const requestResolution = () => requestResolutionSettings(config)
-
 const App: React.FunctionComponent<unknown> = () => {
-  const enabled = useCheckSettings(config)
+  const [enabled, requestResolution] = useLocationSettings({
+    priority: HIGH_ACCURACY,
+    alwaysShow: true,
+    needBle: true,
+  })
 
   return (
     <View style={styles.container}>

src/__mocks__/react-native-location-settings-enabler.ts

@@ -7,8 +7,7 @@ export default {
     LOW_POWER: 104,
     NO_POWER: 105,
   },
-  useCheckSettings: jest.fn(() => true || false),
-  useRequestResolutionSettings: jest.fn(() => true || false),
+  useLocationSettings: jest.fn(() => [Boolean, jest.fn()]),
   checkSettings: jest.fn(),
   requestResolutionSettings: jest.fn(),
   addListener: jest.fn(() => {

src/__tests__/index.test.tsx

@@ -12,22 +12,13 @@ describe("Test native module 'react-native-location-settings-enabler'", () => {
     needBle: false,
   }
 
-  test("[ LocationSettingsEnabler.useCheckSettings ] is a valid hook method", () => {
-    const useCheckSettings = LocationSettingsEnabler.useCheckSettings
-    expect(useCheckSettings).toBeTruthy()
-    expect(useCheckSettings(options)).toBe(true || false)
-  })
-
-  test("[ LocationSettingsEnabler.useRequestResolutionSettings ] is a valid hook method", () => {
-    const useRequestResolutionSettings = LocationSettingsEnabler.useRequestResolutionSettings
-    expect(useRequestResolutionSettings).toBeTruthy()
-    expect(useRequestResolutionSettings(options)).toBe(true || false)
-  })
-
-  test("[ LocationSettingsEnabler.useCheckSettings ] is a valid hook method", () => {
-    const addListener = LocationSettingsEnabler.addListener
-    expect(addListener).toBeTruthy()
-    expect(addListener(listner).remove).toBeTruthy()
+  test("[ LocationSettingsEnabler.useLocationSettings ] is a valid hook method", () => {
+    const useLocationSettings = LocationSettingsEnabler.useLocationSettings
+    expect(useLocationSettings).toBeTruthy()
+    const [enabled, requestResolution] = useLocationSettings(options)
+    expect(enabled).toBe(Boolean)
+    expect(requestResolution).toBeTruthy()
+    expect(requestResolution()).toBeUndefined()
   })
 
   test("[ LocationSettingsEnabler.addListener ] is a valid function subscriber", () => {

src/index.ts

@@ -1,6 +1,12 @@
 import { useState, useEffect } from "react"
 import { NativeModules, NativeEventEmitter } from "react-native"
-import type { LocationSettingsEnablerType, Listener, Config, LocationStatus } from "./types"
+import type {
+  LocationSettingsEnablerType,
+  Listener,
+  Config,
+  LocationStatus,
+  LocationSettings,
+} from "./types"
 
 const { LocationSettingsEnabler } = NativeModules
 const EVENT_NAME = "onChangeLocationSettings"
@@ -16,10 +22,10 @@ LocationSettingsEnabler.once = (listener: Listener, context?: any) =>
 
 LocationSettingsEnabler.PRIORITIES = LocationSettingsEnabler.getConstants()
 
-LocationSettingsEnabler.useCheckSettings = (
+LocationSettingsEnabler.useLocationSettings = (
   settings: Config,
   initial?: LocationStatus,
-): LocationStatus => {
+): LocationSettings => {
   const [enabled, setEnabled] = useState<LocationStatus>(initial || undefined)
   useEffect(() => {
     const listner = LocationSettingsEnabler.addListener(({ locationEnabled }) =>
@@ -29,23 +35,7 @@ LocationSettingsEnabler.useCheckSettings = (
     if (enabled) listner.remove()
     return () => listner.remove()
   }, [enabled])
-  return enabled
-}
-
-LocationSettingsEnabler.useRequestResolutionSettings = (
-  settings: Config,
-  initial?: LocationStatus,
-): LocationStatus => {
-  const [enabled, setEnabled] = useState<LocationStatus>(initial || undefined)
-  useEffect(() => {
-    const listner = LocationSettingsEnabler.addListener(({ locationEnabled }) =>
-      setEnabled(locationEnabled),
-    )
-    LocationSettingsEnabler.requestResolutionSettings(settings)
-    if (enabled) listner.remove()
-    return () => listner.remove()
-  }, [enabled])
-  return enabled
+  return [enabled, () => LocationSettingsEnabler.requestResolutionSettings(settings)]
 }
 
 export default LocationSettingsEnabler as LocationSettingsEnablerType

src/types.ts

@@ -52,6 +52,8 @@ export type Listener = (args: { locationEnabled: boolean }) => void
 
 export type LocationStatus = boolean | undefined
 
+export type LocationSettings = [LocationStatus, () => void]
+
 export interface LocationSettingsEnablerType {
   /**
    * Static object contain a list quality of service for location updates.
@@ -62,22 +64,13 @@ export interface LocationSettingsEnablerType {
   PRIORITIES: Priorities
 
   /**
-   * Hooks let you check if the user's device location is turned off / on.
-   *
-   * @param config -
-   * @param initial? -
-   * @returns boolean | false - location status
-   */
-  useCheckSettings(config: Config, initial?: LocationStatus): LocationStatus
-
-  /**
-   * Hooks let display an activity where the user's can turn location 'on'
+   * Hook let you check the user's device location status 'on' / 'off' and method let you display an activity where they can turn location 'on'.
    *
    * @param config -
    * @param initial? -
-   * @returns boolean | false - location status
+   * @returns LocationSettings - location status
    */
-  useRequestResolutionSettings(config: Config, initial?: LocationStatus): LocationStatus
+  useLocationSettings(config: Config, initial?: LocationStatus): LocationSettings
 
   /**
    * Checking if the user's device location is turned off.