Design a typed collection API

Problem

What becomes confusing, fragile, or impossible without understanding design a typed collection API? This lesson answers that through explanation, a worked example, two runnable exercises, and a reference solution. No teacher-supplied worksheet is required.

TypeScript added gradual static analysis to JavaScript without replacing its runtime, preserving ecosystem compatibility through erasure.

Concept explanation

Design a typed collection API belongs to “Generics express relationships”. design a typed collection API ships as one thin, inspectable slice of a small generic data transformation library.

For design a typed collection API, trace concrete input, state transition, output, and failure through a compile-time relationship that constrains JavaScript while leaving runtime values and external data untrusted.

Types constrain possible programs during analysis, then disappear. Runtime values remain JavaScript values and external data remains untrusted. Apply that model to supplied normal, boundary, and failure cases; each case below names its input and expected evidence.

Example bank

Compare normal, boundary, failure, and cross-layer cases. Predict each observation before revealing the explanation.

Worked example

Start from supplied lab.ts. Focus: Add design a typed collection API to a small generic data transformation library; demo it with: Implement typed groupBy/get/collection transform with keyof constraint.

1. Run: npx tsc --strict --noEmit lab.ts
2. Save baseline evidence. Read inferred types, diagnostics, emitted JavaScript, declarations, module traces, and source maps.
3. Boundary case: Document and test shipped slice under: Compare inference with explicit and needless type parameters.
4. Failure case: Add recovery behavior and a regression check for: Permit unrelated output type and show unsound assertion, then remove it.

RESULT
Fresh clone or blank directory can run documented slice and reproduce: Call sites infer precise types; invalid key fails compile; no assertion hides relationship. Starter-level baseline: Strict type checking exits successfully. Changing result.value to a string-only operation produces a compiler diagnostic.

Starter material

Create lab.ts, paste this exact content, then run the command below.

type Observation<T> = { topic: string; value: T; valid: boolean };

function observe<T>(topic: string, value: T): Observation<T> {
  return { topic, value, valid: value !== undefined };
}

const result = observe("design a typed collection API", 1);
console.log(result.value);

STOP / CLEANUPCompiler exits by itself; no cleanup command required.

Independent exercise

Make it recoverable: design a typed collection API

1. Create second case from blank file: Document and test shipped slice under: Compare inference with explicit and needless type parameters.
2. Then create controlled failure: Add recovery behavior and a regression check for: Permit unrelated output type and show unsound assertion, then remove it.
3. Use tsc · hx LSP · emitted JS · source maps to prove behavior, then repair controlled failure.
4. Compare result against supplied acceptance checks and reference approach before marking complete.

Expected result

• Fresh clone or blank directory can run documented slice and reproduce: Call sites infer precise types; invalid key fails compile; no assertion hides relationship.
• Strict type checking exits successfully. Changing result.value to a string-only operation produces a compiler diagnostic.
• Controlled design a typed collection API failure produces captured evidence; repair restores stated invariant without hiding error.

Hints

Solution

Attempt both exercises before opening reference approach.