Skip to content

purge ¤

Command to purge downloads.

Functions:

  • purge –

    Purge subcommand.

purge ¤

purge(api: API) -> int

Purge subcommand.

Parameters:

  • api (API) –

    The API instance to use.

Returns:

  • int ( int ) –

    0 if all success, 1 if one failure.

Source code in src/aria2p/cli/commands/purge.py 
11
12
13
14
15
16
17
18
19
20
21
22
def purge(api: API) -> int:
    """Purge subcommand.

    Parameters:
        api: The API instance to use.

    Returns:
        int: 0 if all success, 1 if one failure.
    """
    if api.autopurge():
        return 0
    return 1