Get-ChuckNorrisJoke.ps1

19 Sep 2025

• Description
  • Script
  • Download
  • Report Issues

---

Description

@GitHub Copilot - Welcome @BanterBoy, I’m your Copilot and I’m here to help you get things done faster. I can identify issues, explain and even improve code.

You can ask generic questions, but what I’m really good at is helping you with your code. For example:

Generate unit tests for my code Explain the selected code Propose a fix for the bugs in my code If you want to learn more about my capabilities and limitations, check out the Copilot documentation.

I’m powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve.

@BanterBoy: - Explain what the script does and why it is useful.

@GitHub Copilot -

---

Script

#requires -PSEdition Desktop
function Get-ChuckNorrisJoke {
    <#
        .SYNOPSIS
        Retrieves a random Chuck Norris joke from the public Chuck Norris API.

        .DESCRIPTION
        The Get-ChuckNorrisJoke function queries the Chuck Norris API (https://api.chucknorris.io) and returns the
        details of a random joke. Use the ListCategories switch to retrieve the available joke categories or
        the Category parameter to request a joke from a specific category.

        .PARAMETER Category
        Optional category filter applied to the API request. Use -ListCategories to view available categories.

        .PARAMETER ListCategories
        Returns the available joke categories without requesting a joke.

        .EXAMPLE
        Get-ChuckNorrisJoke

        Retrieves a random joke and returns a custom object containing the joke text and metadata.

        .EXAMPLE
        Get-ChuckNorrisJoke -Category dev

        Retrieves a random joke from the "dev" category.

        .EXAMPLE
        Get-ChuckNorrisJoke -ListCategories

        Returns the available categories published by the API.
    #>
    [CmdletBinding(DefaultParameterSetName = 'Random')]
    param(
        [Parameter(ParameterSetName = 'Random')]
        [ValidateNotNullOrEmpty()]
        [string]$Category,

        [Parameter(ParameterSetName = 'Categories')]
        [switch]$ListCategories
    )

    $baseUri = 'https://api.chucknorris.io/jokes'

    if ($PSCmdlet.ParameterSetName -eq 'Categories') {
        return Invoke-RestMethod -Uri "$baseUri/categories" -Method Get -ErrorAction Stop | Sort-Object
    }

    $uri = "$baseUri/random"
    if ($Category) {
        $uri = "$uri?category=$Category"
    }

    try {
        $response = Invoke-RestMethod -Uri $uri -Method Get -ErrorAction Stop
    }
    catch {
        throw "Failed to retrieve joke from API: $($_.Exception.Message)"
    }

    [PSCustomObject]@{
        Id         = $response.id
        Joke       = $response.value
        Url        = $response.url
        Categories = $response.categories
        CreatedAt  = if ($response.created_at) { Get-Date $response.created_at } else { $null }
        UpdatedAt  = if ($response.updated_at) { Get-Date $response.updated_at } else { $null }
    }
}

Back to Top

---

Download

Please feel free to copy parts of the script or if you would like to download the entire script, simple click the download button. You can download the complete repository in a zip file by clicking the Download link in the menu bar on the left hand side of the page.

---

Report Issues

You can report an issue or contribute to this site on GitHub. Simply click the button below and add any relevant notes. I will attempt to respond to all issues as soon as possible.

Issue

---

Back to Top