stratadb / PathValue

Type Alias: PathValue<T, P>

type PathValue<T, P> = Get<T, P>;

Defined in: src/path-types.ts:79

Gets the type at a specific document path.

Type Parameters

T

T

The document type

P

P extends string

The path string (must be a valid path in T)

Remarks

Extracts the TypeScript type of the value at the given path. Uses type-fest's Get utility internally. Provides compile-time type safety for nested property access.

Example

interface User extends Document {
  name: string;
  profile: {
    settings: {
      theme: 'light' | 'dark';
    };
  };
}

type ThemeType = PathValue<User, 'profile.settings.theme'>;  // 'light' | 'dark'
type NameType = PathValue<User, 'name'>;  // string
type ProfileType = PathValue<User, 'profile'>;  // { settings: { theme: 'light' | 'dark' } }

// Compiler errors for invalid paths:
// type Invalid = PathValue<User, 'profile.nonexistent'>;  // Error: Property doesn't exist
// type WrongType = PathValue<User, 'name'> extends number ? number : never;  // Error: string is not number