Aqua.TextCleaningExtensions
Open Source and Free Text Cleaning Package
Install / Use
/learn @ualehosaini/Aqua.TextCleaningExtensionsREADME
Aqua.TextCleaningExtensions
Aqua Text cleaning Extensions Package is an Open Source and Free Software package consists of a set of utilities that facilitate the job of the developer and save his time while cleaning text. Every developer could be a beneficiary of this library; however, those who deal with database and integration applications are likely the most potential beneficiaries.
Getting Started
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
- Installation process
- Software dependencies
- Latest releases
- API references
List of Features and Methods
- IsNullOrEmpty
- IsNullOrWhiteSpace
- RemoveWideSpaces
- ReplaceTabsWithSpaces
- NewLinesToWhiteSpaces
- ToCleanText
Features and Methods
IsNullOrEmpty
IsNullOrEmpty is an extension method, equivalent for the traditional string.IsNullOrEmpty() static method. Returns true if the string examined is null or empty, otherwise returns false.
//using Aqua.TextCleaningExtensions;
string input;
bool output;
input = null;
output = input.IsNullOrEmpty(); // output = true
input = "";
output = input.IsNullOrEmpty(); // output = true
input = " ";
output = input.IsNullOrEmpty(); // output = false
input = "lorem ipsum dolor";
output = input.IsNullOrEmpty(); // output = false
:back:Back to the Full List of Features
IsNullOrWhiteSpace
IsNullOrEmpty is an extension method, equivalent for the traditional string.IsNullOrWhiteSpace() static method. Returns true if the string examined is null or empty, otherwise returns false.
//using Aqua.TextCleaningExtensions;
string input;
bool output;
input = null;
output = input.IsNullOrWhiteSpace(); // output = true
input = "";
output = input.IsNullOrWhiteSpace(); // output = true
input = " ";
output = input.IsNullOrWhiteSpace(); // output = false
input = "lorem ipsum dolor";
output = input.IsNullOrWhiteSpace(); // output = false
RemoveWideSpaces
//using Aqua.TextCleaningExtensions;
string input;
string output;
input = null;
output = input.RemoveWideSpaces(); // output = null
input = "";
output = input.RemoveWideSpaces(); // output = ""
input = " ";
output = input.RemoveWideSpaces(); // output = ""
input = "lorem ipsum";
output = input.RemoveWideSpaces(); // output = "lorem ipsum"
input = " lorem ipsum lorem ipsum ";
output = input.RemoveWideSpaces(); // output = "lorem ipsum lorem ipsum"
:back:Back to the Full List of Features
ReplaceTabsWithSpaces
//using Aqua.TextCleaningExtensions;
string input;
string output;
input = null;
output = input.ReplaceTabsWithSpaces(); // output = null
input = "";
output = input.ReplaceTabsWithSpaces(); // output = ""
input = " ";
output = input.ReplaceTabsWithSpaces(); // output = ""
input = "lorem ipsum"; //4 tabs were here
output = input.ReplaceTabsWithSpaces(); // output = "lorem ipsum"
input = " lorem ipsum "; //6 tabs were here
output = input.ReplaceTabsWithSpaces(); // output = "lorem ipsum"
:back:Back to the Full List of Features
NewLinesToWhiteSpaces
//using Aqua.TextCleaningExtensions;
string input;
string output;
input = null;
output = input.NewLinesToWhiteSpaces(); // output = null
input = "";
output = input.NewLinesToWhiteSpaces(); // output = ""
input = " ";
output = input.NewLinesToWhiteSpaces(); // output = ""
input = "lorem\nipsum";
output = input.NewLinesToWhiteSpaces(); // output = "lorem ipsum"
input = "\nlorem\n\n ipsum\ndolor";
output = input.NewLinesToWhiteSpaces(); // output = "lorem ipsum dolor"
:back:Back to the Full List of Features
ToCleanText
//using Aqua.TextCleaningExtensions;
string input;
string output;
input = null;
output = input.ToCleanText(); // output = null
input = "";
output = input.ToCleanText(); // output = ""
input = " ";
output = input.ToCleanText(); // output = ""
input = " lorem ipsum ";
output = input.ToCleanString(); // output = "lorem ipsum"
input = " lorem\n ipsum\n"; // there is mix of \n \t and spaces
output = input.ToCleanText(); // output = "lorem ipsum"
:back:Back to the Full List of Features
Build and Test
TODO: Describe and show how to build your code and run the tests.
Contribute
TODO: Explain how other users and developers can contribute to make your code better.
If you want to learn more about creating good readme files then refer the following guidelines. You can also seek inspiration from the below readme files:
