ids.ts
types/ids.ts
No strong subsystem tag
45
Lines
1295
Bytes
5
Exports
0
Imports
10
Keywords
What this is
This page documents one file from the repository and includes its full source so you can read it without leaving the docs site.
Beginner explanation
This file is one piece of the larger system. Its name, directory, imports, and exports show where it fits. Start by reading the exports and related files first.
How it is used
Start from the exports list and related files. Those are the easiest clues for where this file fits into the system.
Expert explanation
Architecturally, this file intersects with general runtime concerns. It contains 45 lines, 0 detected imports, and 5 detected exports.
Important relationships
Detected exports
SessionIdAgentIdasSessionIdasAgentIdtoAgentId
Keywords
agentidsessionsessionidagentbrandcreateagentidwhenuniquelyidentifiesreturned
Detected imports
- No import paths detected.
Source notes
This page embeds the full file contents. Small or leaf files are still indexed honestly instead of being over-explained.
Full source
/**
* Branded types for session and agent IDs.
* These prevent accidentally mixing up session IDs and agent IDs at compile time.
*/
/**
* A session ID uniquely identifies a Claude Code session.
* Returned by getSessionId().
*/
export type SessionId = string & { readonly __brand: 'SessionId' }
/**
* An agent ID uniquely identifies a subagent within a session.
* Returned by createAgentId().
* When present, indicates the context is a subagent (not the main session).
*/
export type AgentId = string & { readonly __brand: 'AgentId' }
/**
* Cast a raw string to SessionId.
* Use sparingly - prefer getSessionId() when possible.
*/
export function asSessionId(id: string): SessionId {
return id as SessionId
}
/**
* Cast a raw string to AgentId.
* Use sparingly - prefer createAgentId() when possible.
*/
export function asAgentId(id: string): AgentId {
return id as AgentId
}
const AGENT_ID_PATTERN = /^a(?:.+-)?[0-9a-f]{16}$/
/**
* Validate and brand a string as AgentId.
* Matches the format produced by createAgentId(): `a` + optional `<label>-` + 16 hex chars.
* Returns null if the string doesn't match (e.g. teammate names, team-addressing).
*/
export function toAgentId(s: string): AgentId | null {
return AGENT_ID_PATTERN.test(s) ? (s as AgentId) : null
}