https://github.com/jpillora/go-realtime

Keep your Go structs in sync with your JS objects
https://github.com/jpillora/go-realtime

Last synced: 3 months ago
JSON representation

Keep your Go structs in sync with your JS objects

• Host: GitHub
• URL: https://github.com/jpillora/go-realtime
• Owner: jpillora
• License: mit
• Created: 2015-05-31T07:44:23.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-02-21T15:41:17.000Z (almost 9 years ago)
• Last Synced: 2024-04-09T22:11:26.081Z (9 months ago)
• Language: JavaScript
• Size: 164 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

:warning: This project has been rewritten, simplified and now been deprecated.

## See https://github.com/jpillora/velox

---

### go-realtime

Keep your Go structs in sync with your JS objects

:warning: This project is in beta and the API may change

### Features

* Simple API

* Works with any JSON marshallable struct

* Delta updates using JSONPatch

### Quick Usage

Server

``` go

type Foo struct {

	realtime.Object

	A, B int

}

foo := &Foo{}

//create handler and add foo

rt := realtime.NewHandler()

rt.Add("foo", foo)

//serve websockets and realtime.js client library 

http.Handle("/realtime", rt)

//...later...

//make changes

foo.A = 42

//push to client

foo.Update()

```

Client

``` js

var foo = {};

var rt = realtime("/realtime");

rt.add("foo", foo, function onupdate() {

	//do stuff with foo...

});

```

### Example

See [example](example/) which is running live here https://go-realtime-demo.herokuapp.com/

### Notes

* Object synchronization is currently one way (server to client) only.

* Client object properties beginning with `$` will be ignored.

#### MIT License

Copyright © 2015 Jaime Pillora <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the

'Software'), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to

permit persons to whom the Software is furnished to do so, subject to

the following conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.