https://github.com/nativescript/nativescript-android-livesync-lib
JavaScript library for livesyncing changes to a NativeScript application on android.
https://github.com/nativescript/nativescript-android-livesync-lib
Last synced: 5 months ago
JSON representation
JavaScript library for livesyncing changes to a NativeScript application on android.
- Host: GitHub
- URL: https://github.com/nativescript/nativescript-android-livesync-lib
- Owner: NativeScript
- License: apache-2.0
- Created: 2018-06-06T14:12:43.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-01-07T16:38:27.000Z (over 7 years ago)
- Last Synced: 2025-04-02T11:23:05.163Z (about 1 year ago)
- Language: JavaScript
- Size: 842 KB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nativescript-android-livesync-lib
JavaScript library for livesyncing changes to a NativeScript application on Android.
## System requirements
In order to use this package you need:
- NativeScript Android Runtime 4.2.0 or later
- Node.js 4.0.0 or later
- npm 2.0.0 or later added to your PATH environment variable (you should be able to execute `npm --version` from your default terminal).
## Usage
The library has a few public methods that allow file manipulation to the files of a NativeScript application and provide control for refreshing the application. Restarting the application if necessary should be done by the user of this library.
### Creating instance
Calling the constructor of the LivesyncClass.
Example:
```
LivesyncTool = require("nativescript-android-livesync-lib");
livesyncTool = new LivesyncTool();
```
### Calling connect
Connect method will establish a fresh socket connection with the application. The method takes a configuration as a parameter.
Example:
```
/**
* address defaults to "127.0.0.1".
* port defaults to "18182".
*/
var configuration = {
baseDir: /c/myprojects/myapp/app/,
fullApplicationName: "com.tns.myapp",
deviceIdentifier: "aaaaaaaa"
address: '127.0.0.2'
port: 18183
}
livesyncTool.connect(configuration)
```
The method returns a promise which is resolved once the connection is established.
### Calling sendFile
Send file will create/update the file with the file content it reads from the filePath that is provided. It will compute the relative path based on the base path provided as argument or the one provided in configuration that was passed to constructor.
Example:
```
livesyncTool.sendFile("/c/myprojects/myapp/app/index.js", "/c/myprojects/myapp/app/");
livesyncTool.sendFile("/c/myprojects/myapp/app/index.js");
```
### Calling deleteFile
When called, deleteFile will compute the relative path based on the base path provided as argument or the one provided in the `init` method and delete the corresponding file/directory on the device.
Example:
```
livesyncTool.sendFile("/c/myprojects/myapp/app/index.js", "/c/myprojects/myapp/app/");
livesyncTool.sendFile("/c/myprojects/myapp/app/index.js");
```
## Protocol:
|Operation Name | Operation | Operation id | File Name Length Size | File Name Length | File Name | File Content Length Size | File Content Length | Header Hash | File Content | File hash |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| runSync: | 9 | 32bit | | | | | | md5 hash | | |
| create: | 8 | | 1 | 7 | ./a.txt | 1 | 11 | md5 hash | fileContent | md5 hash |
| delete: | 7 | | 1 | 3 | ./a | | | md5 hash | | |