Yozian Extension

https://github.com/yozian/yozian.extension
Admin
A C# library providing useful extension methods for various types, including collections, strings,...
Tokens:1,193
Snippets:6
Trust Score:6.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### Paginate IQueryable with ToPagination Extension Method

Source: https://github.com/yozian/yozian.extension/blob/master/README.md

Demonstrates the fundamental usage of the `ToPagination` and `ToPaginationAsync` extension methods on an `IQueryable<T>` source. It shows how to retrieve a specific page of data, including both synchronous and asynchronous examples for basic pagination.

```csharp
        var count = 10;
        var size = 3;
        var source = Enumerable
            .Range(1, count)
            .AsQueryable();

        Pageable<int> result = source.ToPagination(1, size);

        // Async 
        Pageable<int> result = await source.ToPaginationAsync(1, size);
```

--------------------------------

### Paginate IQueryable with Custom Type Conversion

Source: https://github.com/yozian/yozian.extension/blob/master/README.md

Illustrates how to apply a converter function during pagination using `ToPagination` and `ToPaginationAsync`. This allows transforming the type of records within the `Pageable` object, for example, converting integers to strings, providing flexibility in data representation.

```csharp
        var count = 10;
        var size = 3;
        var source = Enumerable
            .Range(1, count)
            .AsQueryable();

        Pageable<int, string> result = source.ToPagination(1, size, x => x.ToString());

        // Async 
        Pageable<int, string> result = await source.ToPaginationAsync(1, size, x => x.ToString());
```

--------------------------------

### Convert Pageable to Page Object with Navigation Info

Source: https://github.com/yozian/yozian.extension/blob/master/README.md

Demonstrates converting a `Pageable<T>` object into a `Page<T>` or `Page<U>` object using `ToPage()`. The `Page` object includes additional navigation information like total count, page count, and navigation pages, useful for UI pagination controls. An example JSON structure of the `Page<int>` object is provided to illustrate its properties.

```csharp
        var count = 32;
        var size = 3;
        var source = Enumerable
            .Range(1, count)
            .AsQueryable();
        var currentPage = 3;

        var result = source.ToPagination(currentPage, size);

        var pageSize = 5;

        // converte to Page<T>, including navigation info.
        Page<int> page = result.ToPage(pageSize);
    
        // also provide tranform method to map records
        Page<string> page = result.ToPage(pageSize, x => x.ToString());
```

```APIDOC
{
  "TotalCount": 32,
  "PageCount": 11,
  "CurrentPage": 3,
  "Size": 3,
  "Records": [
    7,
    8,
    9
  ],
  "PageSize": 5,
  "HasPreviosPages": false,
  "HasNextPages": true,
  "PreviosLastPageNo": 1,
  "NextStartPageNo": 6,
  "NavigationPages": [
    1,
    2,
    3,
    4,
    5
  ]
}
```

--------------------------------

### Yozian.Extension Methods Overview

Source: https://github.com/yozian/yozian.extension/blob/master/README.md

This section provides an overview of the extension methods available in the `Yozian.Extension` library, categorized by the type they extend. Each entry lists the extension class and its primary methods, offering a quick reference to the library's functionalities.

```APIDOC
ExceptionExtension:
  DumpDetail()
ExpressionExtension:
  GetMemberName()
ICollectionExtension:
  AddWhen()
  RemoveWhen()
IDictionaryExtension:
  SafeGet()
IEnumerableExtension:
  ForEach()
  FlattenToString()
IQueryableExtension:
  WhereWhen()
ObjectExtension:
  SafeToString()
  ConvertAll()
  ShallowClone()
StringExtension:
  ToEnum()
  LimitLength()
  Repeat()
PaginationExtension:
  ToPagination()
  ToPaginationAsync()
```

--------------------------------

### Fetch Subsequent Pages from a Paginated Queryable

Source: https://github.com/yozian/yozian.extension/blob/master/README.md

Shows how to iteratively fetch subsequent pages from the same `Pageable` source using the `FetchNextPage()` method within a `do-while` loop. This pattern is useful for processing all records across multiple pages without re-querying the original data source for each page.

```csharp
        var count = 10;
        var size = 3;
        var source = Enumerable
            .Range(1, count)
            .AsQueryable();

        Pageable<int, string> result = source.ToPagination(1, size, x => x.ToString());

        do
        {
            // process records here
            result.Records.ForEach(it =>
            {
                // do somthing

            });

            result.FetchNextPage();

        }
        while (result.HasNextPage);
```

--------------------------------

### Simplify Conditional LINQ Queries with WhereWhen Extension

Source: https://github.com/yozian/yozian.extension/blob/master/README.md

This C# code snippet demonstrates the use of the `WhereWhen` extension method on `IQueryable` to conditionally apply `Where` clauses. It eliminates the need for explicit `if` statements, making LINQ queries more concise and readable for dynamic filtering based on conditions. The second code block shows the 'old school' approach for comparison.

```csharp
var books = await this.dbContext.Book
                .Where(x => x.Name.Equals(request.Name))
                .WhereWhen(
                    !string.IsNullOrEmpty(request.Category),
                    x => x.Category.Equals(request.Category)
                )
                .WhereWhen(
                    request.PublishDate.HasValue,
                    x => x.PublishDate.Equals(request.PublishDate)
                )
                .ToListAsync();
```

```csharp
var query = this.dbContext.Book
                .Where(x => x.Name.Equals(request.Name));

if(!string.IsNullOrEmpty(request.Category)){
    query = query.Where(x => x.Category.Equals(request.Category))
}

if(request.PublishDate.HasValue){
    query = query.Where(x => x.PublishDate.Equals(request.PublishDate))
}

var books = await query.ToListAsync();
```
Tokens:
Raw