Domain

declare class DocgenError extends YieldableError<this> & {
  readonly _tag: "DocgenError";
} & Readonly<{
  readonly message: string;
}> {
  constructor(args: {
    readonly message: string;
  });
}

declare class Class extends DocEntry {
  constructor(name: string, doc: Doc, signature: string, position: Position, methods: readonly Array<DocEntry>, staticMethods: readonly Array<DocEntry>, properties: readonly Array<DocEntry>);
  readonly _tag: "Class";
  readonly methods: readonly Array<DocEntry>;
  readonly properties: readonly Array<DocEntry>;
  readonly staticMethods: readonly Array<DocEntry>;
}

declare class Constant extends DocEntry {
  constructor(name: string, doc: Doc, signature: string, position: Position);
  readonly _tag: "Constant";
}

declare class Doc {
  constructor(description: string | undefined, since: readonly Array<string>, deprecated: readonly Array<string>, examples: readonly Array<string>, category: readonly Array<string>, throws: readonly Array<string>, sees: readonly Array<string>, tags: Record<string, ReadonlyArray<string> | undefined>);
  readonly category: readonly Array<string>;
  readonly deprecated: readonly Array<string>;
  readonly description: string | undefined;
  readonly examples: readonly Array<string>;
  readonly sees: readonly Array<string>;
  readonly since: readonly Array<string>;
  readonly tags: Record<string, ReadonlyArray<string> | undefined>;
  readonly throws: readonly Array<string>;
  modifyDescription(description: string | undefined): Doc;
}

declare class DocEntry {
  constructor(name: string, doc: Doc, signature: string, position: Position);
  readonly doc: Doc;
  readonly name: string;
  readonly position: Position;
  readonly signature: string;
}

declare class Export extends DocEntry {
  constructor(
    name: string,
    doc: Doc,
    signature: string,
    position: Position,
    isNamespaceExport: boolean,
  );
  readonly _tag: "Export";
  readonly isNamespaceExport: boolean;
}

declare class File {
  constructor(path: string, content: string, isOverwriteable: boolean);
  readonly content: string;
  readonly isOverwriteable: boolean;
  readonly path: string;
}

declare class Function extends DocEntry {
  constructor(name: string, doc: Doc, signature: string, position: Position);
  readonly _tag: "Function";
}

declare class Interface extends DocEntry {
  constructor(name: string, doc: Doc, signature: string, position: Position);
  readonly _tag: "Interface";
}

declare class Module {
  constructor(source: SourceShape, name: string, doc: Doc, path: readonly [string, string], classes: readonly Array<Class>, interfaces: readonly Array<Interface>, functions: readonly Array<Function>, typeAliases: readonly Array<TypeAlias>, constants: readonly Array<Constant>, exports: readonly Array<Export>, namespaces: readonly Array<Namespace>);
  readonly classes: readonly Array<Class>;
  readonly constants: readonly Array<Constant>;
  readonly doc: Doc;
  readonly exports: readonly Array<Export>;
  readonly functions: readonly Array<Function>;
  readonly interfaces: readonly Array<Interface>;
  readonly name: string;
  readonly namespaces: readonly Array<Namespace>;
  readonly path: readonly [string, string];
  readonly source: SourceShape;
  readonly typeAliases: readonly Array<TypeAlias>;
}

declare class Namespace {
  constructor(name: string, doc: Doc, position: Position, interfaces: readonly Array<Interface>, typeAliases: readonly Array<TypeAlias>, namespaces: readonly Array<Namespace>);
  readonly _tag: "Namespace";
  readonly doc: Doc;
  readonly interfaces: readonly Array<Interface>;
  readonly name: string;
  readonly namespaces: readonly Array<Namespace>;
  readonly position: Position;
  readonly typeAliases: readonly Array<TypeAlias>;
}

interface Position {
  readonly column: number;
  readonly line: number;
}

declare class TypeAlias extends DocEntry {
  constructor(name: string, doc: Doc, signature: string, position: Position);
  readonly _tag: "TypeAlias";
}

declare class Process extends Shape<
  "@effect/docgen/Process",
  {
    readonly argv: Effect<Array<string>>;
    readonly cwd: Effect<string>;
    readonly env: Effect<Record<string, string>>;
    readonly platform: Effect<Platform>;
  },
  this
> {
  constructor(_: never);
  static readonly layer: Layer<Process, never, never>;
}

declare const ByPath: Order.Order<Module>;

declare const DocgenErrorTypeId: typeof DocgenErrorTypeId;

type DocgenErrorTypeId = typeof DocgenErrorTypeId;