refactor: rename types to match Tokio naming conventions

Author: NathanFlurry

README.md

@@ -14,7 +14,8 @@
 
 ## Why Antiox?
 
-- **Zero cost:** No custom DSL, no wrapper types, no extra allocations, and no dependencies. Intentionally does not implement `Result`, `Option`, or `match` — TypeScript's `T | null`, union types, and `switch` already cover these at zero cost.
+- **Async primitives:** Channels, streams, select, tasks, and more. Everything you need for structured concurrency and backpressure in TypeScript.
+- **Lightweight** No custom DSL, no wrapper types, no unnecessary allocations, and no dependencies. Intentionally does not implement `Result`, `Option`, or `match`. TypeScript's `T | null`, union types, and `switch` already cover these at zero cost.
 - **Rust-shaped:** The control flow and concurrency patterns you miss from Rust, mapped onto native JS primitives. Because let's be honest, you wish you were writing Rust instead.
 - **Lightweight:** Every module is tree-shakeable and tiny enough to ship as a transitive dependency without burdening downstream consumers.
 
@@ -406,9 +407,9 @@ guard.disarm(); // or prevent cleanup
 Priority queue-backed channel. Messages received in priority order.
 
 ```typescript
-import { priorityChannel } from "antiox/sync/priority_channel";
+import { channel } from "antiox/sync/priority_channel";
 
-const [tx, rx] = priorityChannel<number>();
+const [tx, rx] = channel<number>();
 tx.send(3);
 tx.send(1);
 tx.send(2);

src/mod.ts

@@ -27,9 +27,9 @@ export {
 } from "./sync/mpsc";
 
 export {
-	priorityChannel,
-	PrioritySender,
-	PriorityReceiver,
+	channel as priorityChannel,
+	Sender as PrioritySender,
+	Receiver as PriorityReceiver,
 } from "./sync/priority_channel";
 export type { TrySendErrorKind, TryRecvErrorKind } from "./sync/mpsc";
 

src/sync/priority_channel.ts

@@ -52,20 +52,20 @@ interface PriorityChannelState<T> {
  * @param compare - Comparator function. Positive return means `a` has higher
  *   priority. Defaults to max-ordering for numbers/strings.
  */
-export function priorityChannel<T>(
+export function channel<T>(
 	compare?: (a: T, b: T) => number,
-): [PrioritySender<T>, PriorityReceiver<T>] {
+): [Sender<T>, Receiver<T>] {
 	const state: PriorityChannelState<T> = {
 		heap: new BinaryHeap(compare),
 		closed: false,
 		senderCount: 1,
 		recvWaiters: [],
 	};
-	return [new PrioritySender(state), new PriorityReceiver(state)];
+	return [new Sender(state), new Receiver(state)];
 }
 
 /** Sending half of a priority channel. */
-export class PrioritySender<T> {
+export class Sender<T> {
 	#state: PriorityChannelState<T>;
 	#dropped = false;
 
@@ -96,10 +96,10 @@ export class PrioritySender<T> {
 	}
 
 	/** Clone this sender. */
-	clone(): PrioritySender<T> {
-		if (this.#dropped) throw new Error("Cannot clone a dropped PrioritySender");
+	clone(): Sender<T> {
+		if (this.#dropped) throw new Error("Cannot clone a dropped Sender");
 		this.#state.senderCount++;
-		return new PrioritySender(this.#state);
+		return new Sender(this.#state);
 	}
 
 	/** Drop this sender. When all senders drop, receiver gets null. */
@@ -121,7 +121,7 @@ export class PrioritySender<T> {
 }
 
 /** Receiving half of a priority channel. Messages arrive in priority order. */
-export class PriorityReceiver<T> {
+export class Receiver<T> {
 	#state: PriorityChannelState<T>;
 	#closed = false;
 

tests/sync/priority_channel.test.ts

@@ -1,14 +1,14 @@
 import { describe, it, expect } from "vitest";
 import {
-	priorityChannel,
-	PrioritySender,
-	PriorityReceiver,
+	channel,
+	Sender,
+	Receiver,
 	TryRecvError,
 } from "../../src/sync/priority_channel";
 
-describe("priorityChannel", () => {
+describe("channel", () => {
 	it("messages received in priority order (highest first)", async () => {
-		const [tx, rx] = priorityChannel<number>();
+		const [tx, rx] = channel<number>();
 		tx.send(1);
 		tx.send(5);
 		tx.send(3);
@@ -19,7 +19,7 @@ describe("priorityChannel", () => {
 	});
 
 	it("custom comparator (min-heap)", async () => {
-		const [tx, rx] = priorityChannel<number>((a, b) => {
+		const [tx, rx] = channel<number>((a, b) => {
 			if (a < b) return 1;
 			if (a > b) return -1;
 			return 0;
@@ -34,7 +34,7 @@ describe("priorityChannel", () => {
 	});
 
 	it("multi-producer via clone", async () => {
-		const [tx1, rx] = priorityChannel<number>();
+		const [tx1, rx] = channel<number>();
 		const tx2 = tx1.clone();
 
 		tx1.send(3);
@@ -47,7 +47,7 @@ describe("priorityChannel", () => {
 	});
 
 	it("disconnection: sender close -> recv returns null after drain", async () => {
-		const [tx, rx] = priorityChannel<number>();
+		const [tx, rx] = channel<number>();
 		tx.send(10);
 		tx.send(20);
 		tx.close();
@@ -58,7 +58,7 @@ describe("priorityChannel", () => {
 	});
 
 	it("tryRecv success and errors", () => {
-		const [tx, rx] = priorityChannel<number>();
+		const [tx, rx] = channel<number>();
 
 		expect(() => rx.tryRecv()).toThrow(TryRecvError);
 		try {
@@ -80,7 +80,7 @@ describe("priorityChannel", () => {
 	});
 
 	it("async iterator works", async () => {
-		const [tx, rx] = priorityChannel<number>();
+		const [tx, rx] = channel<number>();
 		tx.send(1);
 		tx.send(3);
 		tx.send(2);