< Summary - Kestrun — Combined Coverage

Information
Class: Public.JWT.Add-KrJWTSubject
Assembly: Kestrun.PowerShell.Public
File(s): /home/runner/work/Kestrun/Kestrun/src/PowerShell/Kestrun/Public/JWT/Add-KrJWTSubject.ps1
Tag: Kestrun/Kestrun@9d3a582b2d63930269564a7591aa77ef297cadeb
Line coverage
0%
Covered lines: 0
Uncovered lines: 1
Coverable lines: 1
Total lines: 36
Line coverage: 0%
Branch coverage
N/A
Covered branches: 0
Total branches: 0
Branch coverage: N/A
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100

Metrics

File(s)

/home/runner/work/Kestrun/Kestrun/src/PowerShell/Kestrun/Public/JWT/Add-KrJWTSubject.ps1

#LineLine coverage
 1<#
 2    .SYNOPSIS
 3        Adds a subject to the JWT token builder.
 4    .DESCRIPTION
 5        This function adds a subject to the JWT token builder, allowing for the specification of the token's subject.
 6    .PARAMETER Builder
 7        The JWT token builder to modify.
 8    .PARAMETER Subject
 9        The subject to set for the JWT token.
 10    .OUTPUTS
 11        [Kestrun.Jwt.JwtTokenBuilder]
 12        The modified JWT token builder.
 13    .EXAMPLE
 14        $builder = New-KrJWTTokenBuilder | Add-KrJWTSubject -Subject "mySubject"
 15        This example creates a new JWT token builder and adds a subject to it.
 16    .NOTES
 17        This function is part of the Kestrun.Jwt module and is used to build JWT tokens
 18        Maps to JwtTokenBuilder.WithSubject
 19    .LINK
 20        https://docs.microsoft.com/en-us/dotnet/api/system.identitymodel.tokens.jwt.jwtsecuritytoken
 21#>
 22function Add-KrJWTSubject {
 23    [KestrunRuntimeApi('Everywhere')]
 24    [CmdletBinding()]
 25    [OutputType([Kestrun.Jwt.JwtTokenBuilder])]
 26    param(
 27        [Parameter(Mandatory = $true, ValueFromPipeline)]
 28        [Kestrun.Jwt.JwtTokenBuilder] $Builder,
 29        [Parameter(Mandatory)]
 30        [string] $Subject
 31    )
 32    process {
 033        return $Builder.WithSubject($Subject)
 34    }
 35}
 36

Methods/Properties

Add-KrJWTSubject()