narou
    Preparing search index...

    Interface ParamsBaseWithOrder<TOrder>

    検索APIで共通のクエリパラメータ

    interface ParamsBaseWithOrder<TOrder extends string> {
        gzip?: GzipLevel;
        lim?: number;
        of?: string;
        order?: TOrder;
        out?: "json" | "jsonp";
        st?: number;
    }

    Type Parameters

    • TOrder extends string

    Hierarchy (View Summary)

    Index

    Properties

    gzip? lim? of? order? out? st?

    Properties

    gzip?: GzipLevel

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

    lim?: number

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

    of?: string

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

    order?: TOrder

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

    out?: "json" | "jsonp"

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

    st?: number

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

    Settings

    Member Visibility

    On This Page

    Properties