index.d.ts 2.3 KB

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