Class NoteClient<Tag, Input, Output>

Type Parameters

Tag extends Exclude<NoteType, "portfolio">
Input = Tag extends "short" ? ShortInput : PostInput
Output = Tag extends "short" ? Short : Post

Index

Constructors

Methods

get getAll getBySlug getMany put update

Constructors

constructor

new NoteClient<
    Tag extends "post"
    | "page"
    | "short",
    Input = Tag extends "short" ? ShortInput : PostInput,
    Output = Tag extends "short" ? Short : Post,
>(
    base: ClientBase,
    tag: Tag,
): NoteClient<Tag, Input, Output>
Type Parameters
- Tag extends "post" | "page" | "short"
- Input = Tag extends "short" ? ShortInput : PostInput
- Output = Tag extends "short" ? Short : Post
Parameters
- base: ClientBase
- tag: Tag
Returns NoteClient<Tag, Input, Output>
- Defined in src/post.ts:85

Methods

get

get(
    handleOrCharacterId: HandleOrCharacterId,
    noteId: Numberish,
    options?: CreateOptions,
): Promise<null | Output>
Parameters
- handleOrCharacterId: HandleOrCharacterId
- noteId: Numberish
- Optionaloptions: CreateOptions
Returns Promise<null | Output>
- Defined in src/post.ts:142

getAll

getAll(
handleOrCharacterId: HandleOrCharacterId,
options?: Omit<undefined | NoteQueryOptions, "cursor" | "limit"> & CreateOptions,
): Promise<Output[]>
Parameters
- handleOrCharacterId: HandleOrCharacterId
- Optionaloptions: Omit<undefined | NoteQueryOptions, "cursor" | "limit"> & CreateOptions
Returns Promise<Output[]>
- Defined in src/post.ts:90

getBySlug

getBySlug(
    handleOrCharacterId: HandleOrCharacterId,
    slug: string,
    options?: CreateOptions,
): Promise<null | Output>
Parameters
- handleOrCharacterId: HandleOrCharacterId
- slug: string
- Optionaloptions: CreateOptions
Returns Promise<null | Output>
- Defined in src/post.ts:157

getMany

getMany(
handleOrCharacterId: HandleOrCharacterId,
options?: NoteQueryOptions & CreateOptions,
): Promise<ResultMany<Output>>
Parameters
- handleOrCharacterId: HandleOrCharacterId
- Optionaloptions: NoteQueryOptions & CreateOptions
Returns Promise<ResultMany<Output>>
- Defined in src/post.ts:116

put

put(
    __namedParameters: {
        handleOrCharacterId: HandleOrCharacterId;
        note: Input;
        token: string;
    },
): Promise<{}>
Parameters
- __namedParameters: { handleOrCharacterId: HandleOrCharacterId; note: Input; token: string }
Returns Promise<{}>
- Defined in src/post.ts:184

update

update(__namedParameters: UpdateOptions<Tag>): Promise<Response>
Parameters
- __namedParameters: UpdateOptions<Tag>
Returns Promise<Response>
- Defined in src/post.ts:207