README.md

Facet Documentation Index

Welcome to the Facet documentation! This index will help you navigate all available guides and references for using Facet and its extensions.

Table of Contents

• Facetting: Introduction to Facetting
• Quick Start: Quick Start Guide
• Attribute Reference: Facet Attribute Reference
• Custom Mapping: Custom Mapping with IFacetMapConfiguration & Async Support
• Extension Methods: Extension Methods (LINQ, EF Core, etc.)
• Advanced Scenarios: Advanced Usage Scenarios
• What is Being Generated?: Before/After Examples
• Async Mapping Guide: Asynchronous Mapping with Facet.Mapping
• Facet.Extensions.EFCore: EF Core Async Extension Methods
• Facet.Mapping Reference: Complete Facet.Mapping Documentation

Quick Reference

Basic Usage

[Facet(typeof(User))]
public partial class UserDto { }

var userDto = user.ToFacet<User, UserDto>();

Custom Sync Mapping

public class UserMapper : IFacetMapConfiguration<User, UserDto>
{
    public static void Map(User source, UserDto target)
    {
        target.FullName = $"{source.FirstName} {source.LastName}";
    }
}

Async Mapping

public class UserAsyncMapper : IFacetMapConfigurationAsync<User, UserDto>
{
    public static async Task MapAsync(User source, UserDto target, CancellationToken cancellationToken = default)
    {
        target.ProfilePicture = await GetProfilePictureAsync(source.Id, cancellationToken);
    }
}

var userDto = await user.ToFacetAsync<User, UserDto, UserAsyncMapper>();