Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/holepunchto/bare-kit
Bare for native application development
https://github.com/holepunchto/bare-kit
Last synced: 1 day ago
JSON representation
Bare for native application development
- Host: GitHub
- URL: https://github.com/holepunchto/bare-kit
- Owner: holepunchto
- License: apache-2.0
- Created: 2024-06-21T09:59:39.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-11-08T10:37:01.000Z (9 days ago)
- Last Synced: 2024-11-08T11:27:16.711Z (9 days ago)
- Language: Objective-C
- Homepage:
- Size: 207 KB
- Stars: 12
- Watchers: 6
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-pears - bare-kit - a web worker-like API to start and manage an isolated Bare thread, exposes an RPC abstraction with bindings for various languages (**Awesome Pears 🍐** / Pears)
- awesome-pears - bare-kit - a web worker-like API to start and manage an isolated Bare thread, exposes an RPC abstraction with bindings for various languages (**Awesome Pears 🍐** / Pears)
README
# bare-kit
Bare for native application development. The kit provides a web worker-like API to start and manage an isolated Bare thread, called a worklet[^1], that exposes an RPC abstraction with bindings for various languages.
[^1]: This term was chosen to avoid ambiguity with worker threads as implemented by .
## Usage
### JavaScript
In this example we create a simple RPC instance using Bare Kit that sends a `ping` request, handles the request and outputs `pong` to the console.
Create a new RPC instance, providing a request handler
```js
const rpc = new BareKit.RPC((req) => {
if (req.command === 'ping') {
console.log(req.data.toString())
req.reply('pong')
}
})
```
Create an outgoing request with the command `ping`
```js
const req = rpc.request('ping')
```
Send the request with the data `ping`
```js
req.send('ping')
```
Store the received data and log it to console
```js
const data = await req.reply()
console.log(data.toString())
```
### iOS
In this example we create a simple RPC instance for iOS using Bare Kit and Objective-C that sends a `ping` request, handles the request and outputs `pong`.
Import the BareKit framework
```objc
#import
```
Create a new Bare worklet instance
```objc
BareWorklet *worklet = [[BareWorklet alloc] init];
```
Start the worklet with the specified bundle source
```objc
[worklet start:@"/app.bundle" source:/* Source for `app.bundle` */];
```
Create an IPC instance associated with the worklet
```objc
BareIPC *ipc = [[BareIPC alloc] initWithWorklet:worklet];
```
Define a request handler block
```objc
BareRPCRequestHandler requestHandler = ^(BareRPCIncomingRequest *req, NSError *error) {
if ([req.command isEqualToString:@"ping"]) {
CFShow([req dataWithEncoding:NSUTF8StringEncoding]);
[req reply:@"pong" encoding:NSUTF8StringEncoding];
}
};
```
Create an RPC instance with the IPC and request handler
```objc
BareRPC *rpc = [[BareRPC alloc] initWithIPC:ipc requestHandler:requestHandler];
```
Create an outgoing request with the command `ping`
```objc
BareRPCOutgoingRequest *req = [rpc request:@"ping"];
```
Send the request with the data `ping`
```objc
[req send:@"ping" encoding:NSUTF8StringEncoding];
```
Get the reply data asynchronously and log the received data
```objc
[req reply:NSUTF8StringEncoding completion:^(NSString *data, NSError *error) {
CFShow(data);
}];
```
See for a complete example of using the kit in an iOS application.
### Android
In this example we create a simple RPC instance for Android using Bare Kit and Java that sends a `ping` request, handles the request and outputs `pong`.
Import necessary classes from BareKit.
```java
import to.holepunch.bare.kit.IPC;
import to.holepunch.bare.kit.RPC;
import to.holepunch.bare.kit.Worklet;
```
Create a new worklet instance
```java
Worklet worklet = new Worklet();
```
Start the worklet, loading the bundle from assets
```java
try {
worklet.start("/app.bundle", getAssets().open("app.bundle"));
} catch (Exception e) {
throw new RuntimeException(e);
}
```
Create an IPC instance using the worklet
```java
IPC ipc = new IPC(worklet);
```
Create an RPC instance with the IPC and a request handler
```java
RPC rpc = new RPC(ipc, (req, error) -> {
if (req.command.equals("ping")) {
Log.i(TAG, req.data("UTF-8"));
req.reply("pong", "UTF-8");
}
});
```
Create an outgoing request with command "ping"
```java
RPC.OutgoingRequest req = rpc.request("ping");
```
Send the request with data "ping"
```java
req.send("ping", "UTF-8");
```
Get the reply data asynchronously and log the received data
```java
req.reply("UTF-8", (data, error) -> {
Log.i(TAG, data);
});
```
See for a complete example of using the kit in an Android application.
## License
Apache-2.0