mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
f0ce987bc1
Note that this *trivially* updates project urls by adding the NPM url to the end, even when the urls are almost identical or the DT one is outdated. I'll clean up the urls in a later commit. This PR is unfinished! Please do not merge it yet.
76 lines
2.7 KiB
TypeScript
76 lines
2.7 KiB
TypeScript
// Type definitions for adlib 3.0
|
|
// Project: https://github.com/Esri/adlib, https://arcgis.github.io/ember-arcgis-adlib-service
|
|
// Definitions by: Esri <https://github.com/Esri>
|
|
// Mike Tschudi <https://github.com/MikeTschudi>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.1
|
|
|
|
/*
|
|
| Copyright 2018 Esri
|
|
|
|
|
| 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.
|
|
*/
|
|
|
|
/**
|
|
* Transform function to apply to interpolated value.
|
|
*
|
|
* @param key Path within a handlebar-style expression to attempt to replace; e.g., `s.animal.type` in
|
|
* https://github.com/Esri/adlib#transforms
|
|
* @param value Value to replace expression with
|
|
* @param settings Hash providing values to insert into template; see https://github.com/Esri/adlib#general-pattern
|
|
* @param param Parameter for transform function; e.g., the `optional` transform accepts a count of levels
|
|
* to delete if the value is not found (default is 0--just the current level);
|
|
* see https://github.com/Esri/adlib#optional-transform
|
|
*/
|
|
export interface TransformFunction {
|
|
(
|
|
key: string,
|
|
value: any,
|
|
settings: any,
|
|
param?: any
|
|
): any;
|
|
}
|
|
|
|
/**
|
|
* Set of transformation functions keyed by the transform function's name.
|
|
*/
|
|
export interface TransformsList {
|
|
[ transformFnName: string ]: TransformFunction;
|
|
}
|
|
|
|
/**
|
|
* A JavaScript library for interpolating property values in JSON Objects.
|
|
*
|
|
* @param template A template that possibly containing handlebar-style property values to replace;
|
|
* see https://github.com/Esri/adlib#general-pattern
|
|
* @param settings Hash providing values to insert into template; see https://github.com/Esri/adlib#general-pattern
|
|
* @param transforms Set of transformation functions
|
|
* @return Copy of template with replacements performed
|
|
*/
|
|
export function adlib(
|
|
template: any,
|
|
settings: any,
|
|
transforms?: TransformsList
|
|
): any;
|
|
|
|
/**
|
|
* Reads a template and spits out unique handlebar-style property values.
|
|
*
|
|
* @param template A template that possibly containing handlebar-style property values to replace;
|
|
* see https://github.com/Esri/adlib#general-pattern
|
|
* @return List of unique property values in template
|
|
*/
|
|
export function listDependencies(
|
|
template: any
|
|
): string [];
|