docs(typescript): link to model

thewtex · thewtex · commit ebe279b2fa95 · 2025-04-08T14:42:45.000-04:00
diff --git a/docs/typescript/index.md b/docs/typescript/index.md
@@ -1,6 +1,6 @@
 # API Overview
 
-This documentation provides more detailed information about the *itk-wasm* JavaScript and TypeScript interface.
+This documentation provides more detailed information about the *ITK-Wasm* JavaScript and TypeScript interface.
 
 The **Interface Types** section describes data structures produced and consumed
 by both the *Input/Output* and *Processing Pipelines* functions.
diff --git a/docs/typescript/interface_types/BinaryFile.md b/docs/typescript/interface_types/BinaryFile.md
@@ -1,6 +1,8 @@
 # BinaryFile
 
-A `BinaryFile` represents a binary file. For performance reasons, use [`BinaryStream`](./BinaryStream), when possible, instead. `BinaryFile` is a JavaScript object with the following properties:
+A [`BinaryFile`] represents a binary file. For performance reasons, use [`BinaryStream`](./BinaryStream), when possible, instead. [`BinaryFile`] is a JavaScript object with the following properties:
 
 - `data`: `Uint8Arrray` with the binary data.
 - `path`: File path string.
+
+[`BinaryFile`]: ../../model/BinaryFile.md
diff --git a/docs/typescript/interface_types/BinaryStream.md b/docs/typescript/interface_types/BinaryStream.md
@@ -1,5 +1,7 @@
 # BinaryStream
 
-A `BinaryStream` provides a stream of binary data. `BinaryStream` is a JavaScript object with the following properties:
+A [`BinaryStream`] provides a stream of binary data. [`BinaryStream`] is a JavaScript object with the following properties:
 
 - `data`: `Uint8Array` with the binary data.
+
+[`BinaryStream`]: ../../model/BinaryStream.md
diff --git a/docs/typescript/interface_types/Image.md b/docs/typescript/interface_types/Image.md
@@ -1,8 +1,8 @@
 # Image
 
-An `Image` is the N-dimensional image data structure for *ITK-Wasm*.
+An [`Image`] is the N-dimensional image data structure for *ITK-Wasm*.
 
-`Image` is a JavaScript object with the following properties:
+[`Image`] is a JavaScript object with the following properties:
 
 - `imageType`: The [ImageType](./ImageType) for this image.
 - `name`: An optional name string that describes this image.
@@ -20,3 +20,5 @@ Note that the `origin`, `spacing`, `direction`, and `size` are indexed with an `
 ```
 const tensor = tf.tensor(image.data, image.size.reverse())
 ```
+
+[`Image`]: ../../model/Image.md
diff --git a/docs/typescript/interface_types/ImageType.md b/docs/typescript/interface_types/ImageType.md
@@ -1,6 +1,6 @@
 # ImageType
 
-An `ImageType` describes the type of an [`Image`](./Image). It is a
+An [`ImageType`] describes the type of an [`Image`](./Image). It is a
 JSON object with the following attributes:
 
 - `dimension`: An integer that describes the dimension for the image, typically 2 or 3.
@@ -10,4 +10,6 @@ JSON object with the following attributes:
 
 [`PixelType`]: https://github.com/InsightSoftwareConsortium/ITK-Wasm/blob/main/packages/core/typescript/itk-wasm/src/interface-types/pixel-types.ts
 [`IntTypes`]: https://github.com/InsightSoftwareConsortium/ITK-Wasm/blob/main/packages/core/typescript/itk-wasm/src/interface-types/int-types.ts
-[`FloatTypes`]: https://github.com/InsightSoftwareConsortium/ITK-Wasm/blob/main/packages/core/typescript/itk-wasm/src/interface-types/float-types.ts
+[`FloatTypes`]: https://github.com/InsightSoftwareConsortium/ITK-Wasm/blob/main/packages/core/typescript/itk-wasm/src/interface-types/float-types.ts
+
+[`ImageType`]: ../../model/ImageType.md
diff --git a/docs/typescript/interface_types/JsonCompatible.md b/docs/typescript/interface_types/JsonCompatible.md
@@ -1,3 +1,5 @@
 # JsonCompatible
 
-A `JsonCompatible` interface type represents an object, array, null, number, boolean, or nested version of the same that can be parsed from an arbitrary JSON string.
+A [`JsonCompatible`] interface type represents an object, array, null, number, boolean, or nested version of the same that can be parsed from an arbitrary JSON string.
+
+[`JsonCompatible`]: ../../model/JsonCompatible.md
diff --git a/docs/typescript/interface_types/Mesh.md b/docs/typescript/interface_types/Mesh.md
@@ -1,6 +1,6 @@
 # Mesh
 
-An `Mesh` is the N-dimensional data structure to represent points sets and meshes for *itk-wasm*. It is intended to be used for data transfer and exchange as opposed to processing.
+An [`Mesh`] is the N-dimensional data structure to represent points sets and meshes for *itk-wasm*. It is intended to be used for data transfer and exchange as opposed to processing.
 
 A Mesh is a JavaScript object with the following properties:
 
@@ -18,4 +18,6 @@ A Mesh is a JavaScript object with the following properties:
 
 For more information, see [the description](https://itk.org/ITKSoftwareGuide/html/Book1/ITKSoftwareGuide-Book1ch4.html#x38-640004.3) of an `itk::Mesh` in the ITK Software Guide.
 
-`TypedArray`: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+`TypedArray`: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+
+[`Mesh`]: ../../model/Mesh.md
diff --git a/docs/typescript/interface_types/MeshType.md b/docs/typescript/interface_types/MeshType.md
@@ -1,6 +1,6 @@
 # MeshType
 
-A `MeshType` describes the type of an [`Mesh`](/api/Mesh). It is a JSON object with the following attributes:
+A [`MeshType`] describes the type of an [`Mesh`](/api/Mesh). It is a JSON object with the following attributes:
 
 - `dimension`: The spatial dimension of the mesh.
 - `pointComponentType`: The type of the components used to represent a point. This is one of the [`FloatTypes`].
@@ -14,4 +14,6 @@ A `MeshType` describes the type of an [`Mesh`](/api/Mesh). It is a JSON object w
 
 [`PixelType`]: https://github.com/InsightSoftwareConsortium/ITK-Wasm/blob/main/packages/core/typescript/itk-wasm/src/interface-types/pixel-types.ts
 [`IntTypes`]: https://github.com/InsightSoftwareConsortium/ITK-Wasm/blob/main/packages/core/typescript/itk-wasm/src/interface-types/int-types.ts
-[`FloatTypes`]: https://github.com/InsightSoftwareConsortium/ITK-Wasm/blob/main/packages/core/typescript/itk-wasm/src/interface-types/float-types.ts
+[`FloatTypes`]: https://github.com/InsightSoftwareConsortium/ITK-Wasm/blob/main/packages/core/typescript/itk-wasm/src/interface-types/float-types.ts
+
+[`MeshType`]: ../../model/MeshType.md
diff --git a/docs/typescript/interface_types/PolyData.md b/docs/typescript/interface_types/PolyData.md
@@ -1,6 +1,6 @@
 # PolyData
 
-A `PolyData` is represents renderable geometry.
+A [`PolyData`] is represents renderable geometry.
 
 A PolyData is a JavaScript object with the following properties:
 
@@ -25,4 +25,6 @@ A PolyData is a JavaScript object with the following properties:
 - `pointData`: `null | TypedArray` data associated with points.
 
 - `numberOfCellPixels`: Integer number of cell pixels.
-- `cellData`: `null | TypedArray` data associated with cells.
+- `cellData`: `null | TypedArray` data associated with cells.
+
+[`PolyData`]: ../../model/PolyData.md
diff --git a/docs/typescript/interface_types/TextFile.md b/docs/typescript/interface_types/TextFile.md
@@ -1,6 +1,8 @@
 # TextFile
 
-A `TextFile` represents a text file. For performance reasons, use [`TextStream`](./TextStream), when possible, instead. `TextFile` is a JavaScript object with the following properties:
+A [`TextFile`] represents a text file. For performance reasons, use [`TextStream`](./TextStream), when possible, instead. [`TextFile`] is a JavaScript object with the following properties:
 
 - `data`: String with the text data.
 - `path`: File path string.
+
+[`TextFile`]: ../../model/TextFile.md
diff --git a/docs/typescript/interface_types/TextStream.md b/docs/typescript/interface_types/TextStream.md
@@ -1,5 +1,7 @@
 # TextStream
 
-A `TextStream` provides a stream of text data. `TextStream` is a JavaScript object with the following properties:
+A [`TextStream`] provides a stream of text data. [`TextStream`] is a JavaScript object with the following properties:
 
 - `data`: String with the text data.
+
+[`TextStream`]: ../../model/TextStream.md
diff --git a/docs/typescript/interface_types/Transform.md b/docs/typescript/interface_types/Transform.md
@@ -1,6 +1,6 @@
 # Transform
 
-A `Transform` specifies a spatial transformation that maps points from one coordinate system to another. The `Transform` interface is a JavaScript object with the following properties:
+A [`Transform`] specifies a spatial transformation that maps points from one coordinate system to another. The [`Transform`] interface is a JavaScript object with the following properties:
 
 - `transformType`: The [TransformType](./TransformType) for this transform.
 - `numberOfFixedParameters`: The number of fixed parameters for the transform. Fixed parameters are not optimized during registration.
@@ -12,3 +12,5 @@ A `Transform` specifies a spatial transformation that maps points from one coord
 - `fixedParameters`: A [`TypedArray`] containing the fixed transform parameters.
 
 [`TypedArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+
+[`Transform`]: ../../model/Transform.md
diff --git a/docs/typescript/interface_types/TransformList.md b/docs/typescript/interface_types/TransformList.md
@@ -1,5 +1,8 @@
 # TransformList
 
-A `TransformList` is an ordered sequence of spatial [`Transform`](./Transform) objects.
+A [`TransformList`] is an ordered sequence of spatial [`Transform`] objects.
 
-`TransformList` is a JavaScript array of `Transform` objects.
+[`TransformList`] is a JavaScript array of [`Transform`] objects.
+
+[`Transform`]: ./Transform
+[`TransformList`]: ../../model/TransformList.md
diff --git a/docs/typescript/interface_types/TransformParameterizations.md b/docs/typescript/interface_types/TransformParameterizations.md
@@ -1,6 +1,6 @@
 # TransformParameterizations
 
-The enumeration of transform parameterization values is:
+The enumeration of [`TransformParameterizations`] values is:
 
 - `Composite`
 - `Identity`
@@ -31,4 +31,6 @@ The enumeration of transform parameterization values is:
 - `TimeVaryingVelocityField`
 - `GaussianSmoothingOnUpdateTimeVaryingVelocityField`
 
-The definition of these transform and the meaning of their parameters is described in detail in the [ITK Software Guide, Book 2, Section 3.9](https://github.com/InsightSoftwareConsortium/ITKSoftwareGuide/releases).
+The definition of these transform and the meaning of their parameters is described in detail in the [ITK Software Guide, Book 2, Section 3.9](https://github.com/InsightSoftwareConsortium/ITKSoftwareGuide/releases).
+
+[`TransformParameterizations`]: ../../model/TransformParameterizations.md
diff --git a/docs/typescript/interface_types/TransformType.md b/docs/typescript/interface_types/TransformType.md
@@ -1,8 +1,10 @@
 # TransformType
 
-An `TransformType` describes parameterization, parameter value type, and input and output dimensions of the transform. It is a JavaScript object with the following properties:
+An [`TransformType`] describes parameterization, parameter value type, and input and output dimensions of the transform. It is a JavaScript object with the following properties:
 
 - `transformParameterization`: The [TransformParameterization](./TransformParameterizations) for this transform.
 - `parametersValueType`: Whether the transform parameters are `float32` or `float64`.
 - `inputDimension`: The number of dimensions of the input space.
 - `outputDimension`: The number of dimensions of the output space.
+
+[`TransformType`]: ../../model/TransformType.md
diff --git a/docs/typescript/interface_types/index.md b/docs/typescript/interface_types/index.md
@@ -1,6 +1,6 @@
 # Interface Types
 
-itk-wasm execution pipelines support the following [interface types](https://github.com/InsightSoftwareConsortium/ITK-Wasm/tree/main/packages/core/typescript/itk-wasm/src/interface-types/interface-types.ts):
+ITK-Wasm execution pipelines support the following [interface types](https://github.com/InsightSoftwareConsortium/ITK-Wasm/tree/main/packages/core/typescript/itk-wasm/src/interface-types/interface-types.ts):
 
 ```{toctree}
 :maxdepth: 3
@@ -22,4 +22,4 @@ TransformParameterizations.md
 JsonCompatible.md
 ```
 
-These interfaces types are supported in the [Emscripten interface](/api/browser_pipelines), [WASI](https://wasi.dev/) embedding interfaces, and native or virtual [filesystem IO](../../introduction/file_formats/). They are intended to be forward-compatible with the [WebAssembly Component Model](https://github.com/WebAssembly/component-model).
+These interfaces types are supported in the [Emscripten interface](/api/browser_pipelines), [WASI](https://wasi.dev/) embedding interfaces, and native or virtual [filesystem IO](../../introduction/file_formats/). They are intended to be forward-compatible with the [WebAssembly Component Model](https://github.com/WebAssembly/component-model). More information on the types and their relationships can be found in the [Interface Types Model](../../model/index.md).
