Test GitHubGistStar

Test-GitHubGistStar

SYNOPSIS

Checks if a gist from GitHub is starred.

SYNTAX

Test-GitHubGistStar [-Gist] <String> [-AccessToken <String>] [<CommonParameters>]

DESCRIPTION

Checks if a gist from GitHub is starred. Will return $false if it isn't starred, as well as if it couldn't be checked (due to permissions or non-existence).

The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub

EXAMPLES

EXAMPLE 1

Test-GitHubGistStar -Gist 6cad326836d38bd3a7ae

Returns $true if the gist is starred, or $false if isn't starred or couldn't be checked (due to permissions or non-existence).

PARAMETERS

-AccessToken

If provided, this will be used as the AccessToken for authentication with the REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Gist

The ID of the specific gist that you wish to check.

Type: System.String
Parameter Sets: (All)
Aliases: GistId

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

GitHub.Gist

GitHub.GistComment

GitHub.GistCommit

GitHub.GistFork

GitHub.GistSummary

OUTPUTS

Boolean indicating if the gist was both found and determined to be starred.

NOTES

RELATED LINKS