docs(all): added @jscad/io package docs

Author: z3dev

jsdoc.json

@@ -36,6 +36,7 @@
       "packages/modeling/src/text",
       "packages/modeling/src/utils",
 
+      "packages/io/io/src",
       "packages/io/io-utils",
       "packages/io/3mf-deserializer/src",
       "packages/io/3mf-serializer/src",

packages/io/io/src/deserialize.js

@@ -14,14 +14,17 @@ const transformers = {
 
 /**
  * Deserialize the given source as per the given mimeType.
+ *
  * Options can be provided to over-ride or suppliment the defaults used during deserialization.
- * Options must include 'output' as either 'script' or 'geometry'.
+ *
  * @param {Object} options - options used during deserializing
  * @param {String} mimeType - MIME type of the file
  * @param {String} source - the contents of the file
- * @return {[objects]|string} a list of objects (geometry) or a string (script)
+ * @returns {(Array|String)} either an array of objects (geometry) or a string (script)
+ * @alias module:io.deserialize
  *
  * @example
+ * import { getMimeType, deserialize } from '@jscad/io'
  * const mimetype = getMimeType('svg')
  * const myobjects = deserialize({output: 'geometry', target: 'path2'}, mimetype, source)
  */

packages/io/io/src/index.js

@@ -1,3 +1,6 @@
+/**
+ * @module io
+ */
 export { deserialize } from './deserialize.js'
 export { deserializers } from './deserializers.js'
 

packages/io/io/src/serialize.js

@@ -4,14 +4,18 @@ import { serializers } from './serializers.js'
 
 /**
  * Serialize the given objects as per the given mimeType into the external format.
+ *
  * Options can be provided to over-ride or suppliment the defaults used during serialization.
- * See each serializer package for available options.
+ * @See each serializer package for available options.
+ *
  * @param {Object} options - options used during deserializing
  * @param {String} mimeType - MIME type of the file
  * @param {Object} objects - one or more objects of which to serialize
  * @return {Object} an object containing the serialize data as well as mime type
+ * @alias module:io.serialize
  *
  * @example
+ * import { getMimeType, serialize } from '@jscad/io'
  * const mimetype = getMimeType('svg')
  * const shapes = [primitives.cirlce(), primitives.star()]
  * const output = serialize({units: 'inches'}, mimetype, shapes)