@oada/well-known-json
Version:
Middleware for JSON Well-Known resources
40 lines (39 loc) • 1.35 kB
TypeScript
/**
* @license
* Copyright 2014-2022 Open Ag Data Alliance
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export interface Options {
baseUri?: string;
}
type Collection<T> = Record<string, T> | Iterable<[string, T]>;
type Resources = Collection<Collection<unknown>>;
export declare class WellKnownJSON<In = unknown, Out = unknown> {
#private;
static readonly METHODS: readonly ["OPTIONS", "GET", "HEAD"];
constructor(resources: Resources, options?: Options);
/**
* Get a particular well-known resource
*
* @param name
* @param base
* @returns
*/
getResource(name: string, baseIn?: string, ...rest: [In, Out]): unknown;
/**
* Add Well-Known resource, merging with any preexisting ones
*/
addResource(uri: string, collection: Collection<unknown>): void;
}
export {};