README
¶
go-sfomuseum-airfield-wasm
Go package for compiling methods from the go-sfomuseum-airfield package to a JavaScript-compatible WebAssembly (wasm) binary. It also provides a net/http middleware packages for appending the necessary static assets and HTML resources to use the wasm binary in web applications.
Use
To build the sfomuseum_airfield.wasm binary run the make wasm command, like this:
$> make wasm
GOOS=js GOARCH=wasm go build -mod vendor -ldflags="-s -w" -o static/wasm/sfomuseum_airfield.wasm cmd/lookup/main.go
This will create a new WASM binary in the static/wasm folder. The WASM binary, as written, is very large (11MB) which means it may be prohibitive for any kind of production, interet-facing use. This is particularly true considering that it is possible to compile a static lookup table and query it directly in JavaScript at a fraction of the size of the WASM binary. These are all "known knowns" but WebAssembly continues to be exciting and useful for a variety of reasons and, eventually, some day the binaries won't be so big.
In order to use the WASM binary in your JavaScript you will need to include the wasm_exec.js library that is packaged with the Go programming language. You can also grab a copy from the sfomuseum/go-http-wasm package.
For details on how to work with the wasm_exec.js library please consult the Go WebAssembly wiki page or take a look at the convenience wrapper library included with the sfomuuseum/go-http-wasm package.
Functions
The sfomuseum_airfield.wasm WASM binary exports the following methods with return Javascript Promises:
sfomuseum_lookup_airport
Return a JSON-encoded list of sfomuseum/go-sfomuseum-airfield/airports/sfomuseum.Airport records matching an IATA or ICAO airport code.
sfomuseum_lookup_airport("KSFO")
.then((data) => { ... });
Data is sourced from sfomuseum-data/sfomuseum-data-whosonfirst.
sfomuseum_lookup_airline
Returns a JSON-encoded list of sfomuseum/go-sfomuseum-airfield/airlines/sfomuseum.Airline records matching an IATA or ICAO airport code.
sfomuseum_lookup_airline("AFR")
.then((data) => { ... });
Data is sourced from sfomuseum-data/sfomuseum-data-enterprise.
sfomuseum_lookup_aircraft
Return a JSON-encoded list of sfomuseum/go-sfomuseum-airfield/aircraft/sfomuseum.Aircraft records matching an ICAO aircraft desginator.
sfomuseum_lookup_aircraft("B747")
.then((data) => { ... });
Data is sourced from sfomuseum-data/sfomuseum-data-aircraft.
Example
There is a full working example of this application in the cmd/example folder. To run this application type the following command:
$> make example
go run -mod vendor cmd/example/main.go -port 8080
2023/03/21 18:29:08 Listening for requests on localhost:8080
Then open http://localhost:8080 in a web browser. You should see something like this:
See also
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func LookupAircraftFunc ¶
func LookupAircraftFunc(lookup aircraft.AircraftLookup) js.Func
func LookupAirlineFunc ¶
func LookupAirlineFunc(lookup airlines.AirlinesLookup) js.Func
func LookupAirportFunc ¶
func LookupAirportFunc(lookup airports.AirportsLookup) js.Func
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
package static provides an `embed.FS` containing JavaScript and WebAssembly binaries used by the go-sfomuseum-airfield-wasm tools and methods.
|
package static provides an `embed.FS` containing JavaScript and WebAssembly binaries used by the go-sfomuseum-airfield-wasm tools and methods. |