Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

Extensions

Type extensions

Type extensionDescription
x.Cd(dir)
Signature: dir:string -> IDisposable

Change the current directory (so that relative paths within scripts work properly). Returns a handle to change the current directory back to it's initial state (Because this will change the current directory of the currently running code as well!).

x.ChangeCurrentDirectory(dir)
Signature: dir:string -> IDisposable

Change the current directory (so that relative paths within scripts work properly). Returns a handle to change the current directory back to it's initial state (Because this will change the current directory of the currently running code as well!).

x.DynamicAssemblyBuilder
Signature: AssemblyBuilder
x.DynamicAssemblyBuilder
Signature: AssemblyBuilder
Modifiers: abstract
x.EvalExpression(text)
Signature: text:string -> 'a
Type parameters: 'a

Evaluate the given expression and return its result.

x.EvalExpressionWithOutput(text)
Signature: text:string -> InteractionResult * 'a
Type parameters: 'a
x.EvalInteraction(s)
Signature: s:string -> unit
x.EvalScript(s)
Signature: s:string -> unit
x.EvalScriptAsInteraction(s)
Signature: s:string -> unit

See https://github.com/Microsoft/visualfsharp/issues/1392

x.EvalScriptAsInteractionWithOutput(s)
Signature: s:string -> unit

See https://github.com/Microsoft/visualfsharp/issues/1392

x.Handle f text
Signature: (f:(string -> '?20345)) -> text:string -> HandledResult<'?20345>
Type parameters: '?20345

Handle the given evaluation function

x.Include(dir)
Signature: dir:string -> unit
x.Let varName obj
Signature: varName:string -> obj:'a -> unit
Type parameters: 'a

Assigns the given object to the given name (ie "let varName = obj")

x.Load(file)
Signature: file:string -> unit
x.Open(ns)
Signature: ns:string -> unit
x.Reference(file)
Signature: file:string -> unit
x.TryEvalExpression(s)
Signature: s:string -> (obj * Type) option
x.WithCd dir f
Signature: dir:string -> (f:(unit -> '?20340)) -> '?20340
Type parameters: '?20340

Same as Cd but takes a function for the scope.

x.WithCurrentDirectory dir f
Signature: dir:string -> (f:(unit -> '?20343)) -> '?20343
Type parameters: '?20343

Same as ChangeCurrentDirectory but takes a function for the scope.