< 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@2d87023b37eb91155071c91dd3d6a2eeb3004705

Line coverage

Branch coverage

N/A

Method coverage

Feature is only available for sponsors

Coverage history

Method
Get-KrJWTToken()

#	Line	Line 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`	`#>`
	`21`	`function 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 {`
0	`30`	`return $Result.Token()`
	`31`	`}`
	`32`	`}`
	`33`