feat: update api (#2)

Author: gruffins

README.md

@@ -50,7 +50,7 @@ export default function App() {
   }, []);
 
   useEffect(() => {
-    Birch.identifier = userId
+    Birch.setIdentifier(userId);
   }, [userId]);
 }
 ``` 
@@ -77,7 +77,7 @@ Birch.setConsole(true);
 ```
 
 ```typescript
-const useConsole = await Birch.console();
+const useConsole = await Birch.getConsole();
 ```
 
 ### Remote
@@ -88,7 +88,7 @@ Birch.setRemote(true);
 ```
 
 ```typescript
-const remote = await Birch.remote()
+const remote = await Birch.getRemote()
 ```
 
 ### Level
@@ -99,7 +99,7 @@ Birch.setLevel(Level.Trace)
 ```
 
 ```typescript
-const level = await Birch.level();
+const level = await Birch.getLevel();
 ```
 
 ### Synchronous
@@ -110,7 +110,7 @@ Birch.setSynchronous(true);
 ```
 
 ```typescript
-const sync = await Birch.synchronous();
+const sync = await Birch.getSynchronous();
 ```
 
 ### Debug
@@ -123,7 +123,7 @@ Birch.setDebug(true);
 ```
 
 ```typescript
-const debug = await Birch.debug();
+const debug = await Birch.getDebug();
 ```
 
 ### Encryption
@@ -154,6 +154,10 @@ To comply with different sets of regulations such as GDPR or CCPA, you may be re
 Birch.setOptOut(true);
 ```
 
+```typescript
+const optOut = await Birch.getOptOut();
+```
+
 ### Log Scrubbing
 
 Birch comes preconfigured with an email and password scrubber to ensure sensitive data is __NOT__ logged. Emails and passwords are replaced with `[FILTERED]` at the logger level so the data never reaches Birch servers.

example/src/App.tsx

@@ -34,17 +34,17 @@ export default function App() {
     });
 
     (async () => {
-      setDebug(await Birch.debug());
-      setLevel(await Birch.level());
-      setConsoleLog(await Birch.console());
-      setRemote(await Birch.remote());
-      setSynchronous(await Birch.synchronous());
+      setDebug(await Birch.getDebug());
+      setLevel(await Birch.getLevel());
+      setConsoleLog(await Birch.getConsole());
+      setRemote(await Birch.getRemote());
+      setSynchronous(await Birch.getSynchronous());
     })();
   }, [setDebug, setLevel, setConsoleLog, setRemote, setSynchronous]);
 
   const toggleDebug = useCallback(
     async (_e: GestureResponderEvent) => {
-      const value = await Birch.debug();
+      const value = await Birch.getDebug();
       Birch.setDebug(!value);
       setDebug(!value);
     },
@@ -53,7 +53,7 @@ export default function App() {
 
   const toggleLevel = useCallback(
     async (_e: GestureResponderEvent) => {
-      const value = await Birch.level();
+      const value = await Birch.getLevel();
       switch (value) {
         case Level.Trace:
           Birch.setLevel(Level.Debug);
@@ -90,7 +90,7 @@ export default function App() {
 
   const toggleConsole = useCallback(
     async (_e: GestureResponderEvent) => {
-      const value = await Birch.console();
+      const value = await Birch.getConsole();
       Birch.setConsole(!value);
       setConsoleLog(!value);
     },
@@ -99,7 +99,7 @@ export default function App() {
 
   const toggleRemote = useCallback(
     async (_e: GestureResponderEvent) => {
-      const value = await Birch.remote();
+      const value = await Birch.getRemote();
       Birch.setRemote(!value);
       setRemote(!value);
     },
@@ -108,7 +108,7 @@ export default function App() {
 
   const toggleSynchronous = useCallback(
     async (_e: GestureResponderEvent) => {
-      const value = await Birch.synchronous();
+      const value = await Birch.getSynchronous();
       Birch.setSynchronous(!value);
       setSynchronous(!value);
     },
@@ -136,7 +136,7 @@ export default function App() {
   }, []);
 
   const printCurrentLevel = useCallback(async (_e: GestureResponderEvent) => {
-    console.log(await Birch.currentLevel());
+    console.log(await Birch.getCurrentLevel());
   }, []);
 
   return (

src/index.ts

@@ -45,46 +45,46 @@ function Birch() {
   let scrubbers: Array<Scrubber> = [];
 
   const obj = {
-    debug: async (): Promise<boolean> => {
+    getDebug: async (): Promise<boolean> => {
       return await RNBirch.debug();
     },
     setDebug: (value: boolean) => {
       RNBirch.setDebug(value);
     },
-    optOut: async (): Promise<boolean> => {
+    getOptOut: async (): Promise<boolean> => {
       return await RNBirch.optOut();
     },
     setOptOut: (value: boolean) => {
       RNBirch.setOptOut(value);
     },
-    uuid: async (): Promise<string> => {
+    getUuid: async (): Promise<string> => {
       return await RNBirch.uuid();
     },
-    identifier: async (): Promise<string> => {
+    getIdentifier: async (): Promise<string> => {
       return await RNBirch.identifier();
     },
     setIdentifier: (value?: string) => {
       RNBirch.setIdentifier(value);
     },
-    customProperties: async (): Promise<Record<string, string>> => {
+    getCustomProperties: async (): Promise<Record<string, string>> => {
       return await RNBirch.customProperties();
     },
     setCustomProperties: (value: Record<string, string>) => {
       RNBirch.setCustomProperties(value);
     },
-    console: async (): Promise<boolean> => {
+    getConsole: async (): Promise<boolean> => {
       return await RNBirch.console();
     },
     setConsole: (value: boolean) => {
       RNBirch.setConsole(value);
     },
-    remote: async (): Promise<boolean> => {
+    getRemote: async (): Promise<boolean> => {
       return await RNBirch.remote();
     },
     setRemote: (value: boolean) => {
       RNBirch.setRemote(value);
     },
-    level: async (): Promise<Level | undefined> => {
+    getLevel: async (): Promise<Level | undefined> => {
       const level = await RNBirch.level();
       return level !== undefined ? (level as Level) : undefined;
     },
@@ -95,11 +95,11 @@ function Birch() {
         RNBirch.setLevel(value as number);
       }
     },
-    currentLevel: async (): Promise<Level | undefined> => {
+    getCurrentLevel: async (): Promise<Level | undefined> => {
       const level = await RNBirch.currentLevel();
       return level !== undefined ? (level as Level) : undefined;
     },
-    synchronous: async (): Promise<boolean> => {
+    getSynchronous: async (): Promise<boolean> => {
       return await RNBirch.synchronous();
     },
     setSynchronous: (value: boolean) => {
@@ -163,8 +163,8 @@ function Birch() {
   };
 
   const log = async (level: Level, message: string) => {
-    const current = await obj.currentLevel();
-    const allowConsole = await obj.console();
+    const current = await obj.getCurrentLevel();
+    const allowConsole = await obj.getConsole();
 
     if (allowConsole && current !== undefined && level >= current) {
       switch (level) {