eventCliSession() — astro Function Reference

Architecture documentation for the eventCliSession() function in session.ts from the astro codebase.

Function typescript CoreAstro RenderingEngine calls 1

Entity Profile

CoreAstro→ RenderingEngine→ eventCliSession() — astro Function Reference

Dependency Diagram

graph TD
  10c11669_ae8b_6b2e_8390_ab1d211c70ad["eventCliSession()"]
  5e4918d2_001e_cdf1_6103_dc17a8a94758["session.ts"]
  10c11669_ae8b_6b2e_8390_ab1d211c70ad -->|defined in| 5e4918d2_001e_cdf1_6103_dc17a8a94758
  007fbd21_02cb_46e0_9136_19cdd1636881["createAnonymousConfigInfo()"]
  10c11669_ae8b_6b2e_8390_ab1d211c70ad -->|calls| 007fbd21_02cb_46e0_9136_19cdd1636881
  style 10c11669_ae8b_6b2e_8390_ab1d211c70ad fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro/src/events/session.ts lines 127–141

export function eventCliSession(
	cliCommand: string,
	userConfig: AstroUserConfig,
	flags?: Record<string, any>,
): { eventName: string; payload: EventPayload }[] {
	// Filter out yargs default `_` flag which is the cli command
	const cliFlags = flags ? Object.keys(flags).filter((name) => name != '_') : undefined;

	const payload: EventPayload = {
		cliCommand,
		config: createAnonymousConfigInfo(userConfig),
		flags: cliFlags,
	};
	return [{ eventName: EVENT_SESSION, payload }];
}