Rocketmakers.Templates 0.1.0

There is a newer version of this package available.
See the version list below for details.

dotnet add package Rocketmakers.Templates --version 0.1.0

NuGet\Install-Package Rocketmakers.Templates -Version 0.1.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Rocketmakers.Templates" Version="0.1.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Rocketmakers.Templates --version 0.1.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Rocketmakers.Templates, 0.1.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install Rocketmakers.Templates as a Cake Addin
#addin nuget:?package=Rocketmakers.Templates&version=0.1.0

// Install Rocketmakers.Templates as a Cake Tool
#tool nuget:?package=Rocketmakers.Templates&version=0.1.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Rocketmakers.Templates

A library for interacting with templates stored in a remote repository.

Setup

The template service can be set up like below:

// Initialise the template service
var templateService = new HttpTemplateService(
    repository: new AnonTemplateRepository(
        new HttpClient { BaseAddress = config.RepositoryUrl }
    ),
    cache: new InMemoryTemplateContentCache(
        new InMemoryTemplateContentCacheConfig(
            UseCache: true,
            CacheExpirySeconds: 3600
        )
    )
);

The template service can be injected by using the Rocketmakers.Templates.Http.ServiceCollectionExtensions.AddHttpTemplateService extension method like below:

// Inject service into Microsoft.Extensions.DependencyInjection.IServiceCollection
services.AddHttpTemplateService(
    repositoryUrl: new Uri("http://my-repository-url"), 
    cacheConfig: new InMemoryTemplateContentCacheConfig(
        UseCache: true,
        CacheExpirySeconds: 3600
    )
);

Usage

// Maps to 'myService.json' in the repository containing your templates. This is what contains the 
// metadata describing the location of the layouts and partials comprising your templates
var serviceName = "myService";

// Get the latest templates for your service
TemplateGroup templateGroup = await templateService.GetTemplatesAsync(serviceName); 

var renderer = new HandleBarsTemplateRenderer();

// Update the renderer with the latest templates
await renderer.UpdateTemplateGroupAsync(templateGroup);

// Render the template with the supplied payload of parameters
IReadOnlyCollection<RenderedTemplate> rendered = await renderer.RenderAsync(
    layoutId: "My layout", 
    payload: new { username = "Alan", returnUrl = "https://rocketmakers.com" });

Product	Compatible and additional computed target framework versions.
.NET	net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net6.0
- No dependencies.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Rocketmakers.Templates:

Package	Downloads
Rocketmakers.Templates.Handlebars Package Description	12.0K
Rocketmakers.Templates.Http Package Description	11.9K

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
0.2.1	6,594	5/5/2023
0.2.0	5,260	1/5/2023
0.1.0	415	11/23/2022

Total 12.3K

Current version 415