Skip to content

Commit

Permalink
Add docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
sansyrox committed Nov 23, 2023
1 parent 5a2042e commit ae6e3dd
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions robyn/robyn.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -75,32 +75,80 @@ class QueryParams:


def set(self, key: str, value: str) -> None:
"""
Sets the value of the query parameter with the given key.
If the key already exists, the value will be appended to the list of values.
Args:
key (str): The key of the query parameter
value (str): The value of the query parameter
"""
pass


def get(self, key: str) -> Optional[str]:
"""
Gets the last value of the query parameter with the given key.
Args:
key (str): The key of the query parameter
"""
pass


def empty(self) -> bool:
"""
Returns:
True if the query params are empty, False otherwise
"""
pass


def contains(self, key: str) -> bool:
"""
Returns:
True if the query params contain the key, False otherwise
Args:
key (str): The key of the query parameter
"""
pass

def get_first(self, key: str) -> Optional[str]:
"""
Gets the first value of the query parameter with the given key.
Args:
key (str): The key of the query parameter
"""
pass

def get_all(self, key: str) -> Optional[list[str]]:
"""
Gets all the values of the query parameter with the given key.
Args:
key (str): The key of the query parameter
"""
pass


def extend(self, other: QueryParams) -> None:
"""
Extends the query params with the other query params.
Args:
other (QueryParams): The other QueryParams object
"""
pass


def to_dict(self) -> dict[str, list[str]]:
"""
Returns:
The query params as a dictionary
"""
pass


Expand Down

0 comments on commit ae6e3dd

Please sign in to comment.