Function compilerOperationRequires

compilerOperationRequires<CanBeSkipped, RequiredDataProperties, RequiredConfigurationProperties, CompilationContext>(__namedParameters): CompilerOperation<CompilationContext, CanBeSkipped>
Modify a compiler operation to verify that certain properties exist in the CompilationData and CompilerConfiguration before executing the provided operation. If the properties don't exist, an error message is returned.

This is useful for eliminating repetitive existence checks.
Type Parameters
- CanBeSkipped extends boolean
- RequiredDataProperties extends keyof CompilationData<unknown>
- RequiredConfigurationProperties extends keyof CompilerConfiguration
- CompilationContext = CompilationContextBCH
Parameters
- __namedParameters: {
      canBeSkipped: CanBeSkipped;
      configurationProperties: RequiredConfigurationProperties[];
      dataProperties: RequiredDataProperties[];
      operation: ((identifier, data, configuration) => CompilerOperationResult<CanBeSkipped>);
  }
  - canBeSkipped: CanBeSkipped
  - configurationProperties: RequiredConfigurationProperties[]
  - dataProperties: RequiredDataProperties[]
  - operation: ((identifier, data, configuration) => CompilerOperationResult<CanBeSkipped>)
    - (identifier, data, configuration): CompilerOperationResult<CanBeSkipped>
      Parameters
      identifier: string
      data: CompilationData<CompilationContext> & Required<Pick<CompilationData<CompilationContext>, RequiredDataProperties>>
      configuration: CompilerConfiguration<CompilationContext> & Required<Pick<CompilerConfiguration<CompilationContext>, RequiredConfigurationProperties>>
      Returns CompilerOperationResult<CanBeSkipped>
Returns CompilerOperation<CompilationContext, CanBeSkipped>
- Defined in src/lib/compiler/compiler-operation-helpers.ts:55

Function compilerOperationRequires

Type Parameters

CanBeSkipped extends boolean

RequiredDataProperties extends keyof CompilationData<unknown>

RequiredConfigurationProperties extends keyof CompilerConfiguration

CompilationContext = CompilationContextBCH

Parameters

__namedParameters: {
    canBeSkipped: CanBeSkipped;
    configurationProperties: RequiredConfigurationProperties[];
    dataProperties: RequiredDataProperties[];
    operation: ((identifier, data, configuration) => CompilerOperationResult<CanBeSkipped>);
}

canBeSkipped: CanBeSkipped

configurationProperties: RequiredConfigurationProperties[]

dataProperties: RequiredDataProperties[]

operation: ((identifier, data, configuration) => CompilerOperationResult<CanBeSkipped>)

Parameters

identifier: string

data: CompilationData<CompilationContext> & Required<Pick<CompilationData<CompilationContext>, RequiredDataProperties>>

configuration: CompilerConfiguration<CompilationContext> & Required<Pick<CompilerConfiguration<CompilationContext>, RequiredConfigurationProperties>>

Returns CompilerOperationResult<CanBeSkipped>

Returns CompilerOperation<CompilationContext, CanBeSkipped>

Settings

Member Visibility

Theme

Function compilerOperationRequires

Type Parameters

CanBeSkipped extends boolean

RequiredDataProperties extends keyof CompilationData<unknown>

RequiredConfigurationProperties extends keyof CompilerConfiguration

CompilationContext = CompilationContextBCH

Parameters

__namedParameters: { canBeSkipped: CanBeSkipped; configurationProperties: RequiredConfigurationProperties[]; dataProperties: RequiredDataProperties[]; operation: ((identifier, data, configuration) => CompilerOperationResult<CanBeSkipped>); }

canBeSkipped: CanBeSkipped

configurationProperties: RequiredConfigurationProperties[]

dataProperties: RequiredDataProperties[]

operation: ((identifier, data, configuration) => CompilerOperationResult<CanBeSkipped>)

Parameters

identifier: string

data: CompilationData<CompilationContext> & Required<Pick<CompilationData<CompilationContext>, RequiredDataProperties>>

configuration: CompilerConfiguration<CompilationContext> & Required<Pick<CompilerConfiguration<CompilationContext>, RequiredConfigurationProperties>>

Returns CompilerOperationResult<CanBeSkipped>

Returns CompilerOperation<CompilationContext, CanBeSkipped>

Settings

Member Visibility

Theme

__namedParameters: {
canBeSkipped: CanBeSkipped;
configurationProperties: RequiredConfigurationProperties[];
dataProperties: RequiredDataProperties[];
operation: ((identifier, data, configuration) => CompilerOperationResult<CanBeSkipped>);
}