# Packages
# README
Hogosuru 
Hogosuru is a framework to easily write a complete single page application in Go or just export some functionnality directly accessible in javascript (functionnality that need speed for example).
Documentation
A detailed documentation with code examples can be found here : https://hogosuru.v-ip.fr/
How it work?
He use an addon syscall/js (that catch error) and implement a large part of the major features of javascript directly accessible in go.
For a list of functionnality , see the array of compatibility below or check the name of directory that match the API MDN implementation: https://developer.mozilla.org/fr/docs/Web/API
Each object is herited from a baseobject.BaseObject. The baseobject keep a true JS object reference.
All structure available can interact with this object and use the internal functionnality of each object.
If an error occur , this error is handle and return by each function.
How to use
Just import the lib in your project (hogosuru no need use an extended rewrite of base syscall)
GOOS=js GOARCH=wasm go get github.com/realPy/hogosuru
The project work with Go and Tinygo compiler. Use Go compiler for developpement (faster) and tinygo for production
Use the special "autodiscover" of hogosuru
The autodiscover is a special function.
When a function receives a data which is global object (exemple with the attribute data of an event) or which is not an expected data, it is possible to ask hogosuru to guess the content of the object and to create the corresponding Go object.
This is not magic, and it only works if the type of object has already been seen before (hogosuru keeps in memory the type of objects and their constructor).
It would be possible to register all the objects known to hogosuru but that would amount to integrating the whole implementation in your binary.
When you use an object (by use it or cast it) , the constructor is loaded automatically.
If the type is not known, autodiscover will return an object of type BaseObject
Chaining capabilities
Some structure like nodelist or document can be used with chaining capabilities (function that return one object that will be used immediatly without check error).It's a shortcut that ignores errors. The functions which allow this functionality are by convention with the same prototype, with the same name but which end with "_". It is a convention created for hogosuru. All the functions available in chaining are contained in the "chaining.go" file at the root of each component
How to help
This is a young project and there are a lot of work to do
All help is welcome. If you are interested by this project, please contact me
Implemented API/Object status
| Response | Full | https://developer.mozilla.org/fr/docs/Web/API/Response | | ServiceWorker | Full | https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorker| | ServiceWorkerContainer | Full | https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerContainer| | ServiceWorkerRegistration | Full | https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration | | Storage | Full | https://developer.mozilla.org/fr/docs/Mozilla/Add-ons/WebExtensions/API/storage | | Stream | Partial implemented | https://developer.mozilla.org/fr/docs/Web/API/Streams_API | | StyleSheet | Full | https://developer.mozilla.org/en-US/docs/Web/API/StyleSheet | | Uint8array | Partial implemented | https://developer.mozilla.org/fr/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array | UrlSearchParams | Full | https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams | | Url | Full | https://developer.mozilla.org/en-US/docs/Web/API/URL | | ValidityState | Full | https://developer.mozilla.org/en-US/docs/Web/API/ValidityState | | Websocket | Full | https://developer.mozilla.org/fr/docs/Web/API/WebSocket | | Webassembly | Partial |https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly| | Window | Partial |https://developer.mozilla.org/en-US/docs/Web/API/Window | | Worker | Full | https://developer.mozilla.org/en-US/docs/Web/API/Worker | | WorkerGlobalScope| Partial | https://developer.mozilla.org/en-US/docs/Web/API/WorkerGlobalScope | | XMLHttpRequest | Partial implemented | https://developer.mozilla.org/fr/docs/Web/API/XMLHttpRequest/XMLHttpRequest |
Custom components
A toaster components for hogosuru
https://github.com/realPy/hogosurutoaster
A pagination components for hogosuru with templating
https://github.com/realPy/hogosurupagination
A datatable components for hogosuru with templating
https://github.com/realPy/hogosurudatatable
How to help
All help is welcome. If you are interested by this project, please contact me.