Interface UserSearchParams

ユーザー検索パラメータ

interface UserSearchParams {
    gzip?: GzipLevel;
    lim?: number;
    maxnovel?: number;
    maxreview?: number;
    minnovel?: number;
    minreview?: number;
    name1st?: string;
    notword?: string;
    of?: string;
    order?: UserOrder;
    out?: "json" | "jsonp";
    st?: number;
    userid?: number;
    word?: string;
}

Hierarchy (View Summary)

Properties

gzip? lim? maxnovel? maxreview? minnovel? minreview? name1st? notword? of? order? out? st? userid? word?

Properties

Optionalgzip

gzip?: GzipLevel

gzip圧縮してgzipファイルとして返します。 gzip圧縮レベルを1～5で指定できます。 転送量上限を減らすためにも推奨

Optionallim

lim?: number

最大出力数を指定できます。指定しない場合は20件になります。

Optionalmaxnovel

maxnovel?: number

抽出するユーザの小説投稿数の上限を指定できます。小説投稿件数が指定された数値以下のユーザを抽出します。

Optionalmaxreview

maxreview?: number

抽出するユーザのレビュー投稿数の上限を指定できます。レビュー投稿件数が指定された数値以下のユーザを抽出します。

Optionalminnovel

minnovel?: number

抽出するユーザの小説投稿数の下限を指定できます。小説投稿件数が指定された数値以上のユーザを抽出します。

Optionalminreview

minreview?: number

抽出するユーザのレビュー投稿数の下限を指定できます。レビュー投稿件数が指定された数値以上のユーザを抽出します。

Optionalname1st

name1st?: string

抽出するユーザのユーザ名のフリガナの頭文字を指定できます。頭文字はユーザ名のフリガナをひらがなに変換し、最初の1文字が「ぁ」～「ん」の場合に対象となります。

Optionalnotword

notword?: string

含みたくない単語を指定できます。スペースで区切ることにより含ませない単語を増やせます。部分一致で除外されます。除外の対象はユーザ名とユーザ名のフリガナです。

Optionalof

of?: string

出力する項目を個別に指定できます。未指定時は全項目出力されます。 転送量軽減のため、このパラメータの使用が推奨されます。

Optionalorder

order?: UserOrder

出力順序を指定できます。

Optionalout

out?: "json" | "jsonp"

出力形式を指定 本ライブラリはJSONとJSONPのみ対応

Optionalst

st?: number

表示開始位置の指定です。

Optionaluserid

userid?: number

ユーザIDで抽出可能。

Optionalword

word?: string

単語を指定できます。半角または全角スペースで区切るとAND抽出になります。部分一致でHITします。検索の対象はユーザ名とユーザ名のフリガナです。

Settings

Member Visibility

On This Page

Properties