String (Fake)

String Module

Namespace: Fake.Core
Assembly: Fake.Core.String.dll

Contains basic functions for string manipulation.

Types and nested modules

Type/Module	Description
Operators	FAKE string module operators
String

Functions and values

Function or value	Description
`String.Colon` Full Usage: `String.Colon` Returns: `char`	The colon character Returns: `char`
`String.LinuxLineBreaks` Full Usage: `String.LinuxLineBreaks` Returns: `string`	Represents Linux line breaks Returns: `string`
`String.MacLineBreaks` Full Usage: `String.MacLineBreaks` Returns: `string`	Represents Mac line breaks Returns: `string`
`String.NormalizeVersion version` Full Usage: `String.NormalizeVersion version` Parameters: version : `string` Returns: `string`	Removes all trailing .0 from a version string version : `string` Returns: `string`
`String.WindowsLineBreaks` Full Usage: `String.WindowsLineBreaks` Returns: `string`	Represents Windows line breaks Returns: `string`
`String.charsAndDigits` Full Usage: `String.charsAndDigits` Returns: `char list`	Returns all standard chars and digits. Returns: `char list`
`String.convertFileToWindowsLineBreak arg1 fileName` Full Usage: `String.convertFileToWindowsLineBreak arg1 fileName` Parameters: arg0 : `Encoding` fileName : `string`	arg0 : `Encoding` fileName : `string`
`String.convertFileToWindowsLineBreaksWithEncoding encoding fileName` Full Usage: `String.convertFileToWindowsLineBreaksWithEncoding encoding fileName` Parameters: encoding : `Encoding` fileName : `string`	Reads a file line by line and replaces all line breaks to windows line breaks uses a temp file to store the contents in order to prevent OutOfMemory exceptions encoding : `Encoding` fileName : `string`
`String.convertTextToWindowsLineBreaks text` Full Usage: `String.convertTextToWindowsLineBreaks text` Parameters: text : `string` Returns: `string`	Converts all line breaks in a text to windows line breaks text : `string` Returns: `string`
`String.decodeBase64Utf8String text` Full Usage: `String.decodeBase64Utf8String text` Parameters: text : `string` Returns: `string`	Decodes a Base64-encoded UTF-8-encoded string text : `string` Returns: `string`
`String.encapsulateApostrophe text` Full Usage: `String.encapsulateApostrophe text` Parameters: text : `string` Returns: `string` Modifiers: inline	Encapsulates the Apostrophe text : `string` Returns: `string`
`String.endsWith suffix text` Full Usage: `String.endsWith suffix text` Parameters: suffix : `string` text : `string` Returns: `bool`	Checks whether the given text ends with the given suffix suffix : `string` text : `string` Returns: `bool`
`String.endsWithSlash` Full Usage: `String.endsWithSlash` Returns: `string -> bool`	Determines whether the last character of the given string matches `Path.DirectorySeparatorChar`. Returns: `string -> bool`
`String.isLetterOrDigit c` Full Usage: `String.isLetterOrDigit c` Parameters: c : `char` Returns: `bool`	Checks whether the given char is a standard char or digit. c : `char` Returns: `bool`
`String.isNotNullOrEmpty value` Full Usage: `String.isNotNullOrEmpty value` Parameters: value : `string` Returns: `bool` Modifiers: inline	Returns if the string is not null or empty value : `string` Returns: `bool`
`String.isNullOrEmpty value` Full Usage: `String.isNullOrEmpty value` Parameters: value : `string` Returns: `bool` Modifiers: inline	Returns if the string is null or empty value : `string` Returns: `bool`
`String.isNullOrWhiteSpace value` Full Usage: `String.isNullOrWhiteSpace value` Parameters: value : `string` Returns: `bool` Modifiers: inline	Returns if the string is null or empty or completely whitespace value : `string` Returns: `bool`
`String.isUmlaut c` Full Usage: `String.isUmlaut c` Parameters: c : `char` Returns: `bool`	Checks whether the given char is a german umlaut. c : `char` Returns: `bool`
`String.liftString x` Full Usage: `String.liftString x` Parameters: x : `string` Returns: `string option`	Lifts a string to an option x : `string` Returns: `string option`
`String.removeLineBreaks text` Full Usage: `String.removeLineBreaks text` Parameters: text : `string` Returns: `string` Modifiers: inline	Removes linebreaks from the given string text : `string` Returns: `string`
`String.replace pattern replacement text` Full Usage: `String.replace pattern replacement text` Parameters: pattern : `string` replacement : `string` text : `string` Returns: `string` Modifiers: inline	Replaces the given pattern in the given text with the replacement pattern : `string` replacement : `string` text : `string` Returns: `string`
`String.replaceFirst pattern replacement text` Full Usage: `String.replaceFirst pattern replacement text` Parameters: pattern : `string` replacement : `string` text : `string` Returns: `string`	Replaces the first occurrence of the pattern with the given replacement. pattern : `string` replacement : `string` text : `string` Returns: `string`
`String.separated delimiter items` Full Usage: `String.separated delimiter items` Parameters: delimiter : `string` items : `seq<string>` Returns: `string` Modifiers: inline	Converts a sequence of strings to a string with delimiters delimiter : `string` items : `seq<string>` Returns: `string`
`String.split delimiter text` Full Usage: `String.split delimiter text` Parameters: delimiter : `char` text : `string` Returns: `string list` Modifiers: inline	Splits the given string at the given char delimiter delimiter : `char` text : `string` Returns: `string list`
`String.splitStr delimiterStr text` Full Usage: `String.splitStr delimiterStr text` Parameters: delimiterStr : `string` text : `string` Returns: `string list` Modifiers: inline	Splits the given string at the given string delimiter delimiterStr : `string` text : `string` Returns: `string list`
`String.startsWith prefix text` Full Usage: `String.startsWith prefix text` Parameters: prefix : `string` text : `string` Returns: `bool`	Checks whether the given text starts with the given prefix prefix : `string` text : `string` Returns: `bool`
`String.toLines text` Full Usage: `String.toLines text` Parameters: text : `seq<string>` Returns: `string` Modifiers: inline	Converts a sequence of strings into a string separated with line ends text : `seq<string>` Returns: `string`
`String.toLower s` Full Usage: `String.toLower s` Parameters: s : `string` Returns: `string` Modifiers: inline	Converts all characters in a string to lower case. s : `string` Returns: `string`
`String.trim x` Full Usage: `String.trim x` Parameters: x : `string` Returns: `string` Modifiers: inline	Trims the given string x : `string` Returns: `string`
`String.trimChars chars x` Full Usage: `String.trimChars chars x` Parameters: chars : `char[]` x : `string` Returns: `string` Modifiers: inline	Trims the given string chars : `char[]` x : `string` Returns: `string`
`String.trimEndChars chars x` Full Usage: `String.trimEndChars chars x` Parameters: chars : `char[]` x : `string` Returns: `string` Modifiers: inline	Trims the end of the given string chars : `char[]` x : `string` Returns: `string`
`String.trimSeparator s` Full Usage: `String.trimSeparator s` Parameters: s : `string` Returns: `string` Modifiers: inline	Trims the given string with the DirectorySeparatorChar s : `string` Returns: `string`
`String.trimSlash s` Full Usage: `String.trimSlash s` Parameters: s : `string` Returns: `string` Modifiers: inline	Removes the slashes from the end of the given string s : `string` Returns: `string`
`String.trimSpecialChars text` Full Usage: `String.trimSpecialChars text` Parameters: text : `string` Returns: `string` Modifiers: inline	Trims all special characters from a string. text : `string` Returns: `string`
`String.trimStartChars chars x` Full Usage: `String.trimStartChars chars x` Parameters: chars : `char[]` x : `string` Returns: `string` Modifiers: inline	Trims the start of the given string chars : `char[]` x : `string` Returns: `string`