driftlet 0.12.0 → 0.14.0

package/types/stack.d.ts

@@ -31,16 +31,17 @@ export function drive(d: any, path: any): any;
  */
 export function ohmic(d?: number, carriers?: string[]): any;
 /**
- * A bath: a neutral composition `c` (mol/m³) held at the contact, its levels referred to the
- * charged `reference` species (the ion a reference electrode would sense, e.g. Cl⁻ for
- * Ag/AgCl), which is the terminal.
+ * A bath: a neutral composition `c` (mol/m³) held at the contact. With a `reference`, the charged
+ * species a reference electrode would sense (Cl⁻ for Ag/AgCl), its levels are referred to that
+ * species, which is the terminal. Without one, `bath(c, drive)`, the terminal voltage is the
+ * bath's φ: an ideal salt bridge, the convention of membrane potentials.
  * @param {Record<string, number>} c
- * @param {string} reference
+ * @param {string | number | object} [reference] the reference species, or the drive
  * @param {number | object} [drive]
  * @param {{ offset?: number }} [opts] where the reference species sits relative to the terminal
  *   voltage, V_ref = V + offset (V)
  */
-export function bath(c: Record<string, number>, reference: string, d?: number, { offset }?: {
+export function bath(c: Record<string, number>, reference?: string | number | object, d?: number, { offset }?: {
     offset?: number;
 }): any;
 /**

package/types/types.d.ts

@@ -264,6 +264,11 @@ export type ContactSpeciesLink = "blocked" | "equilibrium" | {
     type: "exchange";
     k: number;
     mu: number;
+} | {
+    type: "velocity";
+    v: number;
+    offset?: number;
+    mu?: number;
 };
 /**
  * 'bulk': the end node is plain bulk (locally neutral, no double layer); 'neutral': no charge at