Struct Transform 

#[non_exhaustive]
pub struct Transform(/* private fields */);

A JavaScript expression that converts between a semantic TypeScript runtime value and its JSON-compatible representation.

The closure receives the JavaScript identifier/expression being transformed and must return a JavaScript expression using that value.

Examples

Convert a JSON string into a TypeScript Date:

use specta_typescript::semantic::Transform;

let transform = Transform::new(|value| format!("new Date({value})"));

Convert a Uint8Array into a JSON array of numbers:

use specta_typescript::semantic::Transform;

let transform = Transform::new(|value| format!("[...{value}]"));

Use Transform::identity when the TypeScript runtime value already has the same representation as the value crossing the wire or when JSON.stringify/JSON.parse is already able to handle the transformation for you.

Implementations

impl Transform

pub fn new(runtime: impl Fn(&str) -> String + Send + Sync + 'static) -> Self

Construct a runtime transform from a JavaScript identifier mapper.

The mapper should return a JavaScript expression, not a statement.

use specta_typescript::semantic::Transform;

let transform = Transform::new(|ident| format!("new URL({ident})"));

pub fn identity() -> Self

Construct an identity runtime transform.

This is useful when a rule only changes the exported TypeScript type, or when one direction does not need runtime conversion.

use specta_typescript::semantic::Transform;

let transform = Transform::identity();

Trait Implementations

impl Clone for Transform

fn clone(&self) -> Transform

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Transform

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.