react-native-xxhash 0.1.3 → 0.1.5

package/README.md

@@ -1,9 +1,18 @@
 # react-native-xxhash
 
-react-native-xxhash
+A React Native library for hashing strings using the fast and deterministic xxHash algorithm. This library provides support for both 64-bit and 128-bit hashing.
+
+## Features
+
+- **High Performance**: xxHash is one of the fastest non-cryptographic hash functions.
+- **Deterministic Hashing**: Ensures consistent results for the same input.
+- **128-bit and 64-bit Support**: Choose between 128-bit and 64-bit hash outputs based on your use case.
+- **Cross-Platform**: Supports both iOS and Android in React Native projects.
 
 ## Installation
 
+To install the library, use either `npm` or `yarn`:
+
 ```sh
 npm install react-native-xxhash
 ```
@@ -12,30 +21,83 @@ npm install react-native-xxhash
 yarn add react-native-xxhash
 ```
 
+## iOS
+```sh
+pod install
+```
+
+---
+
 ## Usage
 
+Here’s how to use the `react-native-xxhash` library in your React Native project:
 
-```js
+### Import the Functions
+```javascript
 import { hash128, hash64 } from 'react-native-xxhash';
+```
 
-// ...
+### Hash a String (128-bit)
+This function generates a fast and deterministic 128-bit hash for a given string input.
+
+```javascript
+const resultHash128 = hash128("hello world");
+console.log('128-bit hash:', resultHash128);
+// Output: A 128-bit hash string
+```
 
-//This function provides a fast and deterministic 128-bit hash for a given string input.
-const result_hash_128_bits = hash128("hello world");
+### Hash a String (64-bit)
+This function generates a fast and deterministic 64-bit hash for a given string input.
 
-//This function provides a fast and deterministic 64-bit hash for a given string input.
-const result_hash_64_bits = hash64("hello world");
+```javascript
+const resultHash64 = hash64("hello world");
+console.log('64-bit hash:', resultHash64);
+// Output: A 64-bit hash string
 ```
 
+### Example Usage in a Component
+```javascript
+import React, { useEffect } from 'react';
+import { Text, View } from 'react-native';
+import { hash128, hash64 } from 'react-native-xxhash';
 
-## Contributing
+const App = () => {
+  useEffect(() => {
+    const hash128Result = hash128("react-native");
+    const hash64Result = hash64("react-native");
 
-See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
+    console.log("128-bit hash:", hash128Result);
+    console.log("64-bit hash:", hash64Result);
+  }, []);
 
-## License
+  return (
+    <View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' }}>
+      <Text>Check your console for hash results!</Text>
+    </View>
+  );
+};
+
+export default App;
+```
+
+---
+
+## API Reference
+
+### `hash128(input: string): string`
+- **Description**: Generates a 128-bit hash for the given string input.
+- **Parameters**:
+  - `input` (string): The string to hash.
+- **Returns**: A 128-bit hash as a string.
 
-MIT
+### `hash64(input: string): string`
+- **Description**: Generates a 64-bit hash for the given string input.
+- **Parameters**:
+  - `input` (string): The string to hash.
+- **Returns**: A 64-bit hash as a string.
 
 ---
 
-Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
+## License
+
+`react-native-xxhash` is released under the MIT License. See the [LICENSE](LICENSE) file for details.

package/ios/Xxhash.mm

@@ -6,7 +6,7 @@
 #import <jsi/jsi.h>
 
 @implementation Xxhash
-RCT_EXPORT_MODULE()
+RCT_EXPORT_MODULE(xxhash)
 
 @synthesize bridge = _bridge;
 @synthesize methodQueue = _methodQueue;
@@ -15,20 +15,24 @@ RCT_EXPORT_MODULE()
   return YES;
 }
 
+RCT_EXPORT_BLOCKING_SYNCHRONOUS_METHOD(install){
+	NSLog(@"Installing JSI bindings for xxhash ...");
+	RCTBridge* bridge = [RCTBridge currentBridge];
+	RCTCxxBridge* cxxBridge = (RCTCxxBridge*)bridge;
 
-- (void)setBridge:(RCTBridge *)bridge {
-  _bridge = bridge;
+	if (cxxBridge == nil) {
+		return @false;
+	}
 
-  RCTCxxBridge *cxxBridge = (RCTCxxBridge *)self.bridge;
-  if (!cxxBridge.runtime) {
-    return;
-  }
+	auto jsiRuntime = (jsi::Runtime*) cxxBridge.runtime;
+	if (jsiRuntime == nil) {
+		return @false;
+	}
 
-  auto jsiRuntime =  (jsi::Runtime*)cxxBridge.runtime;
+	xxhash::install(jsiRuntime);
 
-  xxhash::install(jsiRuntime);
+	return @true;
 }
 
 
-
 @end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-xxhash",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Fast xxHash implementation for React Native",
   "main": "./lib/commonjs/index.js",
   "module": "./lib/module/index.js",