doc.d.ts 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. /**
  2. * Opens the official Angular documentation (angular.io) in a browser, and searches for a
  3. * given keyword.
  4. */
  5. export interface Schema {
  6. /**
  7. * Shows a help message for this command in the console.
  8. */
  9. help?: HelpUnion;
  10. /**
  11. * The keyword to search for, as provided in the search bar in angular.io.
  12. */
  13. keyword?: string;
  14. /**
  15. * When true, searches all of angular.io. Otherwise, searches only API reference
  16. * documentation.
  17. */
  18. search?: boolean;
  19. /**
  20. * Contains the version of Angular to use for the documentation. If not provided, the
  21. * command uses your current Angular core version.
  22. */
  23. version?: VersionUnion;
  24. }
  25. /**
  26. * Shows a help message for this command in the console.
  27. */
  28. export declare type HelpUnion = boolean | HelpEnum;
  29. export declare enum HelpEnum {
  30. HelpJson = "JSON",
  31. Json = "json"
  32. }
  33. /**
  34. * Contains the version of Angular to use for the documentation. If not provided, the
  35. * command uses your current Angular core version.
  36. */
  37. export declare type VersionUnion = number | VersionEnum;
  38. export declare enum VersionEnum {
  39. Next = "next"
  40. }