stratadb / DocumentPath

Type Alias: DocumentPath<T>

type DocumentPath<T> = Paths<T>;

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

Extracts all valid property paths from a document type.

Type Parameters

T

T

The document type

Remarks

Generates a union type of all possible paths through the document structure, including nested properties. Uses type-fest's Paths utility internally.

Example

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

// DocumentPath<User> produces:
// 'name' | 'profile' | 'profile.bio' | 'profile.settings' | 'profile.settings.theme'