Function compilerOperationRequires
compiler Operation Requires< CanBeSkipped , RequiredDataProperties , RequiredConfigurationProperties , CompilationContext > ( __namedParameters: { canBeSkipped: CanBeSkipped ; configurationProperties: RequiredConfigurationProperties [] ; dataProperties: RequiredDataProperties [] ; operation: ( ( identifier: string , data: CompilationData < CompilationContext > & Required < Pick < CompilationData < CompilationContext > , RequiredDataProperties > > , configuration: CompilerConfiguration < CompilationContext , CompilerOperationsKeysCommon , CompilerOperationsSigningSerializationCommon , false , false , false , false > & Required < Pick < CompilerConfiguration < CompilationContext , CompilerOperationsKeysCommon , CompilerOperationsSigningSerializationCommon , false , false , false , false > , RequiredConfigurationProperties > > ) => CompilerOperationResult < CanBeSkipped > ) ; } ) : CompilerOperation < CompilationContext , CanBeSkipped , CompilationData < CompilationContext > , CompilerConfiguration < CompilationContext , CompilerOperationsKeysCommon , CompilerOperationsSigningSerializationCommon , false , false , false , false > >
Type Parameters
CanBeSkipped extends boolean
RequiredDataProperties extends keyof CompilationData < unknown >
Parameters
can Be Skipped: CanBeSkipped
configuration Properties: RequiredConfigurationProperties []
data Properties: RequiredDataProperties []
( identifier: string , data: CompilationData < CompilationContext > & Required < Pick < CompilationData < CompilationContext > , RequiredDataProperties > > , configuration: CompilerConfiguration < CompilationContext , CompilerOperationsKeysCommon , CompilerOperationsSigningSerializationCommon , false , false , false , false > & Required < Pick < CompilerConfiguration < CompilationContext , CompilerOperationsKeysCommon , CompilerOperationsSigningSerializationCommon , false , false , false , false > , RequiredConfigurationProperties > > ) : CompilerOperationResult < 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.