weblog/README.md

99 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

# Weblog
2020-10-19 15:58:38 +00:00
<!-- Version -->
<a href="https://crates.io/crates/weblog">
<img src="https://img.shields.io/crates/v/weblog.svg?style=flat-square"
alt="Crates.io version" />
</a>
<!-- Docs -->
<a href="https://docs.rs/weblog">
<img src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square"
alt="docs.rs docs" />
</a>
weblog is a crate that defines a set of macros for calling `console.log()`, `console.error()` and other members of the browser's console API when targeting Wasm.
2020-09-15 11:20:37 +00:00
## Features
* Supports `web-sys` and `stdweb` backends with an identical public API
* Support for variadic arguments on all calls
* No stringification before sending to the browser - log entire objects and use the full introspective debugging power of the browser console.
2020-09-15 11:20:37 +00:00
## Examples
A simple example.
```rust
console_log!("Hello world!");
```
Passing multiple arguments is fine too.
```rust
console_log!("Foo", "bar", "baz");
```
All of the common browser log levels are supported.
```rust
console_debug!("Just testing...");
console_warn!("...but then...");
console_error!("...something bad happened.");
```
It's possible to send more than just strings or `&str`s:
```rust
console_log!(
"&str",
"string".to_string(),
1,
2.0,
3f32,
true,
false
);
```
When using `web-sys` crate the macros accept any value that implements the `Into<JsValue>` trait. See [JsValue](https://rustwasm.github.io/wasm-bindgen/api/wasm_bindgen/struct.JsValue.html) for
more details.
No stringification is performed on the Rust side - so objects will be fully introspectable in the browser's console!
## Usage
```toml
# Defaults to web-sys
2020-10-19 15:13:28 +00:00
weblog = "0.3.0"
# For stdweb:
2020-10-19 15:13:28 +00:00
weblog = { version = "0.3.0", default-features = false, features = ["std_web"] }
```
See the documentation for usage examples.
The crate currently exposes the following macros:
2020-09-17 14:42:05 +00:00
* `console_assert!`
* `console_clear!`
2020-09-17 14:42:05 +00:00
* `console_count!`
* `console_count_reset!`
* `console_debug!`
* `console_dir!`
* `console_dirxml!`
* `console_error!`
2020-09-17 14:42:05 +00:00
* `console_exception!`
* `console_info!`
* `console_log!`
2020-09-17 14:42:05 +00:00
* `console_table!`
* `console_time!`
* `console_time_end!`
* `console_time_stamp!`
* `console_trace!`
* `console_warn!`
## License
Licensed under MIT or Apache-2.