mirror of
https://github.com/rzmk/czv.git
synced 2026-03-22 06:40:13 +00:00
refactor: use options object for WASM function args, improve docs
- Add relevant links to all READMEs and source code - Resolve clippy lints czv: - Add more docs for top-level items - Add suggestion to use builder methods instead of functions - Disable slice and slice tests until operation is complete czv-wasm: - Use tsify_next for allowing objects as parameters - Add nodejs example and instructions
This commit is contained in:
parent
ce260e9491
commit
e84c5bec8b
20 changed files with 564 additions and 168 deletions
|
|
@ -1,32 +1,50 @@
|
|||
use crate::Result;
|
||||
use csv::ReaderBuilder;
|
||||
use serde::{Deserialize, Serialize};
|
||||
use tsify_next::Tsify;
|
||||
use wasm_bindgen::prelude::*;
|
||||
|
||||
/// Options for `rowCount`.
|
||||
#[derive(Tsify, Serialize, Deserialize)]
|
||||
#[tsify(into_wasm_abi, from_wasm_abi)]
|
||||
pub struct RowCountOptions {
|
||||
/// CSV file data.
|
||||
pub file_data: String,
|
||||
|
||||
#[tsify(optional)]
|
||||
/// Specify whether to include the header row (first row) in the row count.
|
||||
/// Default is false.
|
||||
pub include_header_row: Option<bool>,
|
||||
}
|
||||
|
||||
/// Returns a count of the total number of rows.
|
||||
///
|
||||
/// @param {string} `file_data` CSV file data.
|
||||
/// @param {boolean | undefined} `include_header_row` Specify whether to include the header row (first row) in the row count. Default is false.
|
||||
/// @returns {number}
|
||||
#[wasm_bindgen(skip_jsdoc, js_name = rowCount)]
|
||||
pub fn row_count(file_data: String, include_header_row: Option<bool>) -> Result<usize> {
|
||||
pub fn row_count(options: RowCountOptions) -> Result<usize> {
|
||||
let mut rdr = ReaderBuilder::new();
|
||||
|
||||
rdr.has_headers(!include_header_row.unwrap_or(false));
|
||||
return Ok(rdr.from_reader(file_data.as_bytes()).records().count());
|
||||
rdr.has_headers(!options.include_header_row.unwrap_or(false));
|
||||
|
||||
Ok(rdr
|
||||
.from_reader(options.file_data.as_bytes())
|
||||
.records()
|
||||
.count())
|
||||
}
|
||||
|
||||
/// Options for `columnCount`.
|
||||
#[derive(Tsify, Serialize, Deserialize)]
|
||||
#[tsify(into_wasm_abi, from_wasm_abi)]
|
||||
pub struct ColumnCountOptions {
|
||||
/// CSV file data.
|
||||
pub file_data: String,
|
||||
}
|
||||
|
||||
/// Returns a count of the total number of columns (fields).
|
||||
///
|
||||
/// ## Arguments
|
||||
///
|
||||
/// @param {string} `file_data` CSV file data.
|
||||
#[wasm_bindgen(skip_jsdoc, js_name = columnCount)]
|
||||
pub fn column_count(file_data: Option<String>) -> Result<usize> {
|
||||
pub fn column_count(options: ColumnCountOptions) -> Result<usize> {
|
||||
let rdr = ReaderBuilder::new();
|
||||
|
||||
if let Some(file_data) = file_data {
|
||||
return Ok(rdr.from_reader(file_data.as_bytes()).headers()?.len());
|
||||
} else {
|
||||
bail!("Could not determine a file path or file data for column_count_builder.");
|
||||
}
|
||||
Ok(rdr
|
||||
.from_reader(options.file_data.as_bytes())
|
||||
.headers()?
|
||||
.len())
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,3 +1,45 @@
|
|||
//! # czv
|
||||
//!
|
||||
//! WASM library for [czv](https://github.com/rzmk/czv). CSV operations library for data engineering/analysis tasks.
|
||||
//!
|
||||
//! # Example
|
||||
//!
|
||||
//! Let's say we want to print the total number of non-header rows in our data:
|
||||
//!
|
||||
//! ```js
|
||||
//! import init, * as czv from "czv";
|
||||
//! // Must run `await init()` or `initSync()` first for web use
|
||||
//! await init();
|
||||
//!
|
||||
//! const data = `fruits,price
|
||||
//! apple,2.50
|
||||
//! banana,3.00
|
||||
//! strawberry,1.50`;
|
||||
//!
|
||||
//! const output = czv.rowCount({
|
||||
//! file_data: data,
|
||||
//! include_header_row: true,
|
||||
//! });
|
||||
//!
|
||||
//! console.log(output);
|
||||
//! ```
|
||||
//!
|
||||
//! For a full website example see the example's source code here: https://www.npmjs.com/package/czv) <https://github.com/rzmk/czv/tree/main/czv-wasm/examples/basic-demo>
|
||||
//!
|
||||
//! # Links
|
||||
//!
|
||||
//! - czv GitHub repository: <https://github.com/rzmk/czv>
|
||||
//! - Rust: [crates.io/crates/czv](https://crates.io/crates/czv) ([source code](https://github.com/rzmk/czv/tree/main/czv))
|
||||
//! - WebAssembly (JavaScript/TypeScript): [npmjs.com/package/czv](https://www.npmjs.com/package/czv) ([source code](https://github.com/rzmk/czv/tree/main/czv-wasm))
|
||||
//! - Python: [pypi.org/project/czv](https://pypi.org/project/czv/) ([source code](https://github.com/rzmk/czv/tree/main/czv-python))
|
||||
|
||||
#![allow(
|
||||
// https://github.com/madonoharu/tsify/issues/42
|
||||
non_snake_case,
|
||||
// https://github.com/rustwasm/wasm-bindgen/issues/3945
|
||||
clippy::empty_docs
|
||||
)]
|
||||
|
||||
use wasm_bindgen::JsValue;
|
||||
|
||||
// Error-handling helpers
|
||||
|
|
@ -11,9 +53,15 @@ impl From<csv::Error> for CzvError {
|
|||
}
|
||||
}
|
||||
|
||||
impl Into<JsValue> for CzvError {
|
||||
fn into(self) -> JsValue {
|
||||
JsValue::from_str(self.to_string().as_str())
|
||||
impl From<serde_wasm_bindgen::Error> for CzvError {
|
||||
fn from(value: serde_wasm_bindgen::Error) -> Self {
|
||||
value.into()
|
||||
}
|
||||
}
|
||||
|
||||
impl From<CzvError> for JsValue {
|
||||
fn from(val: CzvError) -> Self {
|
||||
JsValue::from_str(val.to_string().as_str())
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue