Skip to content

Commit b37fae6

Browse files
committed
docs(mesh-io): correct new names for deprecated functions
1 parent afc5470 commit b37fae6

File tree

7 files changed

+13
-13
lines changed

7 files changed

+13
-13
lines changed

docs/development/itk_js_to_itk_wasm_migration_guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,12 +105,12 @@ and `@itk-wasm/mesh-io` package. Their interface changed in some cases.
105105
3. `readImageFileSeries` -> `readImageFileSeries`
106106
4. `readImageHTTP` -> `readImageHttp`
107107
5. `readImageLocalFile` -> `readImageNode`
108-
6. `readMeshArrayBuffer` -> `readMeshFile`
109-
7. `readMeshBlob` -> `readMeshFile`
108+
6. `readMeshArrayBuffer` -> `readMesh`
109+
7. `readMeshBlob` -> `readMesh`
110110
8. `readMeshLocalFile` -> `readMeshNode`
111111
9. `writeImageArrayBuffer` -> `writeImage`
112112
10. `writeImageLocalFile` -> `writeImageNode`
113-
11. `writeMeshArrayBuffer` -> `writeMeshFile`
113+
11. `writeMeshArrayBuffer` -> `writeMesh`
114114
12. `writeMeshLocalFile` -> `writeMeshNode`
115115

116116
### MeshToPolyData

packages/core/typescript/itk-wasm/src/deprecated/read-mesh-array-buffer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import ReadMeshResult from './read-mesh-result.js'
66
* @deprecated Use readMeshArrayBuffer from @itk-wasm/image-io instead
77
*/
88
async function readMeshArrayBuffer (webWorker: Worker | null, arrayBuffer: ArrayBuffer, fileName: string, mimeType: string): Promise<ReadMeshResult> {
9-
throw new Error('readMeshArrayBuffer is deprecated. Use readMeshFile from @itk-wasm/mesh-io instead.')
9+
throw new Error('readMeshArrayBuffer is deprecated. Use readMesh from @itk-wasm/mesh-io instead.')
1010
}
1111

1212
export default readMeshArrayBuffer

packages/core/typescript/itk-wasm/src/deprecated/read-mesh-blob.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import ReadMeshResult from './read-mesh-result.js'
66
* @deprecated Use readMeshBlob from @itk-wasm/mesh-io instead
77
*/
88
async function readMeshBlob (webWorker: Worker | null, blob: Blob, fileName: string, mimeType: string): Promise<ReadMeshResult> {
9-
throw new Error('readMeshBlob is deprecated. Use readMeshFile from @itk-wasm/mesh-io instead.')
9+
throw new Error('readMeshBlob is deprecated. Use readMesh from @itk-wasm/mesh-io instead.')
1010
}
1111

1212
export default readMeshBlob

packages/core/typescript/itk-wasm/src/deprecated/read-mesh-file.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
import ReadMeshResult from './read-mesh-result.js'
44

55
/**
6-
* @deprecated Use readMeshFile from @itk-wasm/mesh-io instead
6+
* @deprecated Use readMesh from @itk-wasm/mesh-io instead
77
*/
88
async function readMeshFile (webWorker: Worker | null, file: File): Promise<ReadMeshResult> {
9-
throw new Error('readMeshFile is deprecated. Use readMeshFile from @itk-wasm/mesh-io instead.')
9+
throw new Error('readMeshFile is deprecated. Use readMesh from @itk-wasm/mesh-io instead.')
1010
}
1111

1212
export default readMeshFile

packages/core/typescript/itk-wasm/src/deprecated/read-mesh-local-file.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
import Mesh from '../interface-types/mesh.js'
44

55
/**
6-
* @deprecated Use readMeshFileNode from @itk-wasm/mesh-io instead
6+
* @deprecated Use readMeshNode from @itk-wasm/mesh-io instead
77
*/
88
async function readMeshLocalFile (filePath: string): Promise<Mesh> {
9-
throw new Error('readMeshLocalFile is deprecated. Use readMeshFileNode from @itk-wasm/mesh-io instead.')
9+
throw new Error('readMeshLocalFile is deprecated. Use readMeshNode from @itk-wasm/mesh-io instead.')
1010
}
1111

1212
export default readMeshLocalFile

packages/core/typescript/itk-wasm/src/deprecated/write-mesh-array-buffer.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ import WriteArrayBufferResult from './write-array-buffer-result.js'
66
import WriteMeshOptions from './write-mesh-options.js'
77

88
/**
9-
* @deprecated Use writeMeshFile from @itk-wasm/mesh-io instead
9+
* @deprecated Use writeMesh from @itk-wasm/mesh-io instead
1010
*/
1111
async function writeMeshArrayBuffer (webWorker: Worker | null, mesh: Mesh, fileName: string, mimeType: string, options: WriteMeshOptions): Promise<WriteArrayBufferResult> {
12-
throw new Error('writeMeshArrayBuffer is deprecated. Use writeMeshFile from @itk-wasm/mesh-io instead.')
12+
throw new Error('writeMeshArrayBuffer is deprecated. Use writeMesh from @itk-wasm/mesh-io instead.')
1313
}
1414

1515
export default writeMeshArrayBuffer

packages/core/typescript/itk-wasm/src/deprecated/write-mesh-local-file.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ import WriteMeshOptions from './write-mesh-options.js'
55
import Mesh from '../interface-types/mesh.js'
66

77
/**
8-
* @deprecated Use writeMeshFileNode from @itk-wasm/mesh-io instead
8+
* @deprecated Use writeMeshNode from @itk-wasm/mesh-io instead
99
*/
1010
async function writeMeshLocalFile (mesh: Mesh, filePath: string, options: WriteMeshOptions): Promise<null> {
11-
throw new Error('writeMeshLocalFile is deprecated. Use writeMeshFileNode from @itk-wasm/mesh-io instead.')
11+
throw new Error('writeMeshLocalFile is deprecated. Use writeMeshNode from @itk-wasm/mesh-io instead.')
1212
}
1313

1414
export default writeMeshLocalFile

0 commit comments

Comments
 (0)