Added docs.

Author: tido64

README.md

@@ -54,12 +54,12 @@ getData = async () => {
 
 ```
 
-See docs for [api and more examples.](docs/API.md)
+See docs for [api and more examples](docs/API.md), and [some advanced usage](docs/AdvancedUsage.md).
 
 ## Contribution
 
 See the [CONTRIBUTING](CONTRIBUTING.md) file for how to help out.
 
 ## License
 
-MIT
+MIT

docs/AdvancedUsage.md

@@ -0,0 +1,82 @@
+# Advanced Usage
+
+## Integrating with Existing Storage Solutions in Hybrid Apps
+
+### iOS
+
+On iOS, AsyncStorage can be controlled by the hosting app via the delegate on
+`RNCAsyncStorage`:
+
+```objc
+RNCAsyncStorage *asyncStorage = [bridge moduleForClass:[RNCAsyncStorage class]];
+asyncStorage.delegate = self;
+```
+
+The delegate must conform to the protocol `RNCAsyncStorageDelegate`:
+
+```objc
+- (void)allKeys:(RNCAsyncStorageResultCallback)block;
+```
+
+Returns all keys currently stored. If none, an empty array is returned.
+Called by `getAllKeys` in JS.
+
+<br />
+
+```objc
+- (void)mergeValues:(NSArray<NSString *> *)values
+            forKeys:(NSArray<NSString *> *)keys
+         completion:(RNCAsyncStorageResultCallback)block;
+```
+
+Merges values with the corresponding values stored at specified keys.
+Called by `mergeItem` and `multiMerge` in JS.
+
+<br />
+
+```objc
+- (void)removeAllValues:(RNCAsyncStorageCompletion)block;
+```
+
+Removes all values from the store. Called by `clear` in JS.
+
+<br />
+
+```objc
+- (void)removeValuesForKeys:(NSArray<NSString *> *)keys
+                 completion:(RNCAsyncStorageResultCallback)block;
+```
+
+Removes all values associated with specified keys.
+Called by `removeItem` and `multiRemove` in JS.
+
+<br />
+
+```objc
+- (void)setValues:(NSArray<NSString *> *)values
+          forKeys:(NSArray<NSString *> *)keys
+       completion:(RNCAsyncStorageResultCallback)block;
+```
+
+Sets specified key-value pairs. Called by `setItem` and `multiSet` in JS.
+
+<br />
+
+```objc
+- (void)valuesForKeys:(NSArray<NSString *> *)keys
+           completion:(RNCAsyncStorageResultCallback)block;
+```
+
+Returns values associated with specified keys.
+Called by `getItem` and `multiGet` in JS.
+
+<br />
+
+```objc
+@optional
+@property (nonatomic, readonly, getter=isPassthrough) BOOL passthrough;
+```
+
+**Optional:** Returns whether the delegate should be treated as a passthrough.
+This is useful for monitoring storage usage among other things. Returns `NO` by
+default.

ios/RNCAsyncStorageDelegate.h

@@ -14,26 +14,59 @@ typedef void (^RNCAsyncStorageResultCallback)(NSArray<id<NSObject>> * valuesOrEr
 
 @protocol RNCAsyncStorageDelegate <NSObject>
 
+/*!
+ * Returns all keys currently stored. If none, an empty array is returned.
+ * @param block Block to call with result.
+ */
 - (void)allKeys:(RNCAsyncStorageResultCallback)block;
 
+/*!
+ * Merges values with the corresponding values stored at specified keys.
+ * @param values Values to merge.
+ * @param keys Keys to the values that should be merged with.
+ * @param block Block to call with merged result.
+ */
 - (void)mergeValues:(NSArray<NSString *> *)values
             forKeys:(NSArray<NSString *> *)keys
          completion:(RNCAsyncStorageResultCallback)block;
 
+/*!
+ * Removes all values from the store.
+ * @param block Block to call with result.
+ */
 - (void)removeAllValues:(RNCAsyncStorageCompletion)block;
 
+/*!
+ * Removes all values associated with specified keys.
+ * @param keys Keys of values to remove.
+ * @param block Block to call with result.
+ */
 - (void)removeValuesForKeys:(NSArray<NSString *> *)keys
                  completion:(RNCAsyncStorageResultCallback)block;
 
+/*!
+ * Sets specified key-value pairs.
+ * @param values Values to set.
+ * @param keys Keys of specified values to set.
+ * @param block Block to call with result.
+ */
 - (void)setValues:(NSArray<NSString *> *)values
           forKeys:(NSArray<NSString *> *)keys
        completion:(RNCAsyncStorageResultCallback)block;
 
+/*!
+ * Returns values associated with specified keys.
+ * @param keys Keys of values to return.
+ * @param block Block to call with result.
+ */
 - (void)valuesForKeys:(NSArray<NSString *> *)keys
            completion:(RNCAsyncStorageResultCallback)block;
 
 @optional
 
+/*!
+ * Returns whether the delegate should be treated as a passthrough.
+ */
 @property (nonatomic, readonly, getter=isPassthrough) BOOL passthrough;
 
 @end