Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DragonsLord/TypeUtilities
https://github.com/DragonsLord/TypeUtilities
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/DragonsLord/TypeUtilities
- Owner: DragonsLord
- License: mit
- Created: 2022-05-13T19:08:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-01T11:17:20.000Z (almost 2 years ago)
- Last Synced: 2024-08-11T09:49:37.802Z (4 months ago)
- Language: C#
- Size: 132 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- RSCG_Examples - https://github.com/DragonsLord/TypeUtilities
README
# TypeUtilities
[](https://github.com/DragonsLord/TypeUtilities/actions/workflows/build.yml)
[](https://www.nuget.org/packages/TypeUtilities/)
Type Utilities provides a source generators to create/transform one type into another.
This project was inspired by the [TypeScript Utility Types](https://www.typescriptlang.org/docs/handbook/utility-types.html) and was ment to bring similar functionality to the C# via source generators
## Installation
To use the the TypeUtilities, install the [TypeUtilities package](https://www.nuget.org/packages/TypeUtilities) into your project.
To install the packages, add the references to your _csproj_ file, for example by running
```bash
dotnet add package TypeUtilities
```
This adds a `` to your project.
## Usage
TypeUtilities provides several attributes:
### Map
Map Attribute simply maps memebers of the source type to the target type using specified format.
```csharp
using TypeUtilities;
using TypeUtilities.Abstractions;
public class SourceType
{
public Guid Id { get; }
public int Value { get; set; }
public DateTime Created { get; set; }
}
[Map(typeof(SourceType))]
public partial class SimpleMap
{
}
// Generated result
//----- SimpleMap.map.SourceType.g.cs
public partial class SimpleMap
{
public System.Guid Id { get; }
public int Value { get; set; }
public System.DateTime Created { get; set; }
}
// --------------------
[Map(typeof(SourceType),
MemberDeclarationFormat = $"{Tokens.Accessibility} string Mapped{Tokens.Name}{Tokens.Accessors}",
MemberKindSelection = MemberKindFlags.ReadonlyProperty
)]
public partial class AdvancedMap
{
}
// Generated result
//----- AdvancedMap.map.SourceType.g.cs
public partial class AdvancedMap
{
public string MappedId { get; }
}
// --------------------
```
More detailed description for Map is provided [here](docs/Map.md)
### Omit
Omit Attribute is similar to Map but also accepts an explicit list of members that should be exluded
```csharp
using TypeUtilities;
public class SourceType
{
public Guid Id { get; }
public int Value { get; set; }
public DateTime Created { get; set; }
}
[Omit(typeof(SourceType), "Value")]
public partial class TargetType
{
public int MyValue { get; set; }
}
// Generated result
//----- TargetType.omit.SourceType.g.cs
public partial class TargetType
{
public Guid Id { get; }
public DateTime Created { get; set; }
}
```
### Pick
Pick Attribute is similar to Map but also requires to explicitly specify all members that should be included
```csharp
using TypeUtilities;
public class SourceType
{
public Guid Id { get; }
public int Value { get; set; }
public DateTime Created { get; set; }
}
[Pick(typeof(SourceType), "Id", nameof(SourceType.Value))]
public partial class TargetType
{
}
// Generated result
//----- TargetType.omit.SourceType.g.cs
public partial class TargetType
{
public Guid Id { get; }
public int Value { get; set; }
}
```