Skip to content

Get-PokeBerry.md

Latest commit

 

History

History
170 lines (127 loc) · 3.22 KB

Get-PokeBerry.md

File metadata and controls

170 lines (127 loc) · 3.22 KB
Raw
external help file PokeAPI-help.xml
grand_parent berry
Module Name PokeAPI
online version https://celerium.github.io/PokeAPI-PowerShellWrapper/site/berry/Get-PokeBerry.html
parent GET
schema 2.0.0
title Get-PokeBerry

Get-PokeBerry

SYNOPSIS

Gets berries from PokeAPI

SYNTAX

index_ByAll (Default)

Get-PokeBerry [-offset <Int32>] [-limit <Int32>] [-allPages] [<CommonParameters>]

index_ById

Get-PokeBerry -id <Int32> [<CommonParameters>]

index_ByName

Get-PokeBerry -name <String> [<CommonParameters>]

DESCRIPTION

The Get-PokeBerry cmdlet gets berries from PokeAPI

Berries are small fruits that can provide HP and status condition restoration, stat enhancement, and even damage negation when eaten by Pokemon

EXAMPLES

EXAMPLE 1

Get-PokeBerry

Gets the first 20 berries sorted by id

EXAMPLE 2

Get-PokeBerry -id 1

Gets the berry with the defined id

EXAMPLE 3

Get-PokeBerry -name ditto

Gets the berry with the defined name

EXAMPLE 4

Get-PokeBerry -offset 151 -limit 100

Gets the first 100 resources starting at resources with an id over 151

PARAMETERS

-id

Defines id of the resource

Type: Int32
Parameter Sets: index_ById
Aliases:

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-name

Defines name of the resource

Type: String
Parameter Sets: index_ByName
Aliases:

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

-offset

Defines the page number to return

By default only 20 resources are returned

Type: Int32
Parameter Sets: index_ByAll
Aliases:

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

-limit

Defines the amount of resources to return with each page

By default only 20 resources are returned

Type: Int32
Parameter Sets: index_ByAll
Aliases:

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

-allPages

Returns all resources from an endpoint

As of 2024-02, there is no cap on how many resources can be returned using the limit parameter. There is currently no real use for this parameter and it was included simply to account if pagination is introduced.

Type: SwitchParameter
Parameter Sets: index_ByAll
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
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

OUTPUTS

NOTES

n/a

RELATED LINKS

https://celerium.github.io/PokeAPI-PowerShellWrapper/site/berry/Get-PokeBerry.html