Gjsify LogoGjsify Logo

Hierarchy

Index

Properties

checkStdout?: boolean

Most build systems will preserve stderr for the processes they call, such as gcc, clang, and others. However, if your build system redirects all output to stdout, you may need to set this property to %TRUE to ensure that Builder will extract errors from stdout.

One such example is Ninja.

cleanLauncher?: Ide.SubprocessLauncher
completed?: boolean

The "completed" property is set to %TRUE after the pipeline has completed processing the stage. When the pipeline invalidates phases, completed may be reset to %FALSE.

context?: Ide.Context
disabled?: boolean

If the build stage is disabled. This allows you to have a stage that is attached but will not be activated during execution.

You may enable it later and then re-execute the pipeline.

If the stage is both transient and disabled, it will not be removed during the transient cleanup phase.

ignoreExitStatus?: boolean
name?: string

The name of the build stage. This is only used by UI to view the build pipeline.

stdoutPath?: string

The "stdout-path" property allows a build stage to redirect its log messages to a stdout file. Instead of passing stdout along to the build pipeline, they will be redirected to this file.

For safety reasons, the contents are first redirected to a temporary file and will be redirected to the stdout-path location after the build stage has completed executing.

transient?: boolean

If the build stage is transient.

A transient build stage is removed after the completion of ide_build_pipeline_execute_async(). This can be a convenient way to add a temporary item to a build pipeline that should be immediately discarded.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method