< Summary - Kestrun — Combined Coverage

Information
Class: Public.JWT.Get-KrJWTToken
Assembly: Kestrun.PowerShell.Public
File(s): /home/runner/work/Kestrun/Kestrun/src/PowerShell/Kestrun/Public/JWT/Get-KrJWTToken.ps1
Tag: Kestrun/Kestrun@9d3a582b2d63930269564a7591aa77ef297cadeb
Line coverage
0%
Covered lines: 0
Uncovered lines: 1
Coverable lines: 1
Total lines: 33
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/Get-KrJWTToken.ps1

#LineLine coverage
 1<#
 2    .SYNOPSIS
 3        Retrieves the JWT token from the builder result.
 4    .DESCRIPTION
 5        This function extracts the JWT token from the builder result, allowing for further processing or output.
 6    .PARAMETER Result
 7        The JWT builder result containing the constructed token.
 8    .OUTPUTS
 9        [string]
 10        The JWT token extracted from the builder result.
 11    .EXAMPLE
 12        $token = New-KrJWTTokenBuilder | Add-KrJWTSubject -Subject "mySubject" | Build-KrJWT |
 13                  Get-KrJWTToken
 14        This example creates a new JWT token builder, adds a subject, builds the JWT token, and then retrieves the token
 15    .NOTES
 16        This function is part of the Kestrun.Jwt module and is used to retrieve JWT tokens.
 17        Maps to JwtBuilderResult.Token
 18    .LINK
 19        https://docs.microsoft.com/en-us/dotnet/api/system.identitymodel.tokens.jwt.jwtsecuritytoken
 20#>
 21function Get-KrJWTToken {
 22    [KestrunRuntimeApi('Everywhere')]
 23    [CmdletBinding()]
 24    [OutputType([string])]
 25    param(
 26        [Parameter(Mandatory = $true, ValueFromPipeline)]
 27        [Kestrun.Jwt.JwtBuilderResult] $Result
 28    )
 29    process {
 030        return $Result.Token()
 31    }
 32}
 33

Methods/Properties

Get-KrJWTToken()