index.d.ts 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. // This file is generated at pre-commit by running `node create-typings.js`.
  2. /**
  3. * Returns a boolean. Will be `true` if the code is running on a CI server,
  4. * otherwise `false`.
  5. *
  6. * Some CI servers not listed here might still trigger the `ci.isCI`
  7. * boolean to be set to `true` if they use certain vendor neutral environment
  8. * variables. In those cases `ci.name` will be `null` and no vendor specific
  9. * boolean will be set to `true`.
  10. */
  11. export const isCI: boolean;
  12. /**
  13. * Returns a boolean if PR detection is supported for the current CI server.
  14. * Will be `true` if a PR is being tested, otherwise `false`. If PR detection is
  15. * not supported for the current CI server, the value will be `null`.
  16. */
  17. export const isPR: boolean | null;
  18. /**
  19. * Returns a string containing name of the CI server the code is running on. If
  20. * CI server is not detected, it returns `null`.
  21. *
  22. * Don't depend on the value of this string not to change for a specific vendor.
  23. * If you find your self writing `ci.name === 'Travis CI'`, you most likely want
  24. * to use `ci.TRAVIS` instead.
  25. */
  26. export const name: string | null;
  27. export const APPCIRCLE: boolean;
  28. export const APPVEYOR: boolean;
  29. export const CODEBUILD: boolean;
  30. export const AZURE_PIPELINES: boolean;
  31. export const BAMBOO: boolean;
  32. export const BITBUCKET: boolean;
  33. export const BITRISE: boolean;
  34. export const BUDDY: boolean;
  35. export const BUILDKITE: boolean;
  36. export const CIRCLE: boolean;
  37. export const CIRRUS: boolean;
  38. export const CODEFRESH: boolean;
  39. export const CODEMAGIC: boolean;
  40. export const CODESHIP: boolean;
  41. export const DRONE: boolean;
  42. export const DSARI: boolean;
  43. export const EAS: boolean;
  44. export const GERRIT: boolean;
  45. export const GITHUB_ACTIONS: boolean;
  46. export const GITLAB: boolean;
  47. export const GOCD: boolean;
  48. export const GOOGLE_CLOUD_BUILD: boolean;
  49. export const HARNESS: boolean;
  50. export const HEROKU: boolean;
  51. export const HUDSON: boolean;
  52. export const JENKINS: boolean;
  53. export const LAYERCI: boolean;
  54. export const MAGNUM: boolean;
  55. export const NETLIFY: boolean;
  56. export const NEVERCODE: boolean;
  57. export const RELEASEHUB: boolean;
  58. export const RENDER: boolean;
  59. export const SAIL: boolean;
  60. export const SCREWDRIVER: boolean;
  61. export const SEMAPHORE: boolean;
  62. export const SHIPPABLE: boolean;
  63. export const SOLANO: boolean;
  64. export const SOURCEHUT: boolean;
  65. export const STRIDER: boolean;
  66. export const TASKCLUSTER: boolean;
  67. export const TEAMCITY: boolean;
  68. export const TRAVIS: boolean;
  69. export const VERCEL: boolean;
  70. export const APPCENTER: boolean;
  71. export const WOODPECKER: boolean;
  72. export const XCODE_CLOUD: boolean;
  73. export const XCODE_SERVER: boolean;