FluidHandler
Defined in: adapters/fluidFramework.ts:17
A FluidFramework build-tools policy handler interface.
This interface matches the Handler interface from @fluidframework/build-tools.
Properties
Section titled “Properties”handler
Section titled “handler”handler: (
file,root) =>Promise<string|undefined>
Defined in: adapters/fluidFramework.ts:35
The handler function that checks a file against the policy.
Parameters
Section titled “Parameters”string
Absolute path to the file.
string
Path to the repo root.
Returns
Section titled “Returns”Promise<string | undefined>
undefined if the check passes, otherwise an error message string.
match:
RegExp
Defined in: adapters/fluidFramework.ts:26
A regex pattern that determines which files this handler applies to.
name:
string
Defined in: adapters/fluidFramework.ts:21
The name of the handler, used for filtering and display.
resolver?
Section titled “resolver?”
optionalresolver?: (file,root) =>Promise<{message?:string;resolved:boolean; }> | {message?:string;resolved:boolean; }
Defined in: adapters/fluidFramework.ts:44
Optional resolver function that attempts to fix policy violations.
Parameters
Section titled “Parameters”string
Absolute path to the file.
string
Path to the repo root.
Returns
Section titled “Returns”An object indicating whether the fix was successful.
Promise<{ message?: string; resolved: boolean; }>
Type Literal
Section titled “Type Literal”{ message?: string; resolved: boolean; }
message?
Section titled “message?”
optionalmessage?:string
Optional explanation of the fix result.
resolved
Section titled “resolved”resolved:
boolean
Whether the violation was fixed.