solarnetwork-api-core
    Preparing search index...

    Interface UriEncodable

    API for an object that can URI encode itself.

    interface UriEncodable {
        toUriEncoding(index?: number, propertyName?: string): string;
    }

    Implemented by

    Index

    Methods

    • Get this object as a standard URI encoded (query parameters) string value.

      Parameters

      • Optionalindex: number

        an optional array property index

      • OptionalpropertyName: string

        an optional array property name, only used if index is also provided; defaults to sorts

      Returns string

      the URI encoded string