Skip to content

Commit 838cd7c

Browse files
committed
Remove non-ASCII from the d.ta file
1 parent 545be14 commit 838cd7c

File tree

1 file changed

+45
-46
lines changed

1 file changed

+45
-46
lines changed

stampit.d.ts

Lines changed: 45 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -82,129 +82,129 @@ interface FactoryFunction<Obj> {
8282
}
8383

8484
/**
85-
* @internal Chainables `Stamp` additionnal methods
85+
* @internal Chainables `Stamp` additional methods
8686
* @template Obj The object type that the `Stamp` will create.
8787
*/
8888
type StampChainables<Obj> = Chainables<StampObjectType<Obj>, StampType<Obj>>;
8989

9090
/**
91-
* @internal Chainables `Stamp` additionnal methods
91+
* @internal Chainables `Stamp` additional methods
9292
* @template Obj The object type that the `Stamp` will create.
93-
* @template S̤t̤a̤m̤p̤ The type of the `Stamp` (when extending a `Stamp`.)
93+
* @template S The type of the `Stamp` (when extending a `Stamp`.)
9494
*/
95-
interface Chainables<Obj, S̤t̤a̤m̤p̤ extends StampSignature> {
95+
interface Chainables<Obj, S extends StampSignature> {
9696
/**
9797
* Add methods to the methods prototype. Creates and returns new Stamp. **Chainable**.
9898
* @template This The type to use for `this` within methods.
9999
* @param methods Object(s) containing map of method names and bodies for delegation.
100100
*/
101101
// tslint:disable-next-line: no-unnecessary-generics
102-
methods<This = Obj>(...methods: Array<MethodMap<This>>): S̤t̤a̤m̤p̤;
102+
methods<This = Obj>(...methods: Array<MethodMap<This>>): S;
103103

104104
/**
105105
* Take a variable number of objects and shallow assign them to any future created instance of the Stamp. Creates and returns new Stamp. **Chainable**.
106106
* @param objects Object(s) to shallow assign for each new object.
107107
*/
108-
properties(...objects: PropertyMap[]): S̤t̤a̤m̤p̤;
108+
properties(...objects: PropertyMap[]): S;
109109

110110
/**
111111
* Take a variable number of objects and shallow assign them to any future created instance of the Stamp. Creates and returns new Stamp. **Chainable**.
112112
* @param objects Object(s) to shallow assign for each new object.
113113
*/
114-
props(...objects: PropertyMap[]): S̤t̤a̤m̤p̤;
114+
props(...objects: PropertyMap[]): S;
115115

116116
/**
117117
* Take a variable number of objects and deeply merge them to any future created instance of the Stamp. Creates and returns a new Stamp. **Chainable**.
118118
* @param deepObjects The object(s) to deeply merge for each new object.
119119
*/
120-
deepProperties(...deepObjects: PropertyMap[]): S̤t̤a̤m̤p̤;
120+
deepProperties(...deepObjects: PropertyMap[]): S;
121121

122122
/**
123123
* Take a variable number of objects and deeply merge them to any future created instance of the Stamp. Creates and returns a new Stamp. **Chainable**.
124124
* @param deepObjects The object(s) to deeply merge for each new object.
125125
*/
126-
deepProps(...deepObjects: PropertyMap[]): S̤t̤a̤m̤p̤;
126+
deepProps(...deepObjects: PropertyMap[]): S;
127127

128128
/**
129129
* Take in a variable number of functions and add them to the initializers prototype as initializers. **Chainable**.
130130
* @param functions Initializer functions used to create private data and privileged methods.
131131
*/
132-
initializers(...functions: Array<stampit.Initializer<Obj, S̤t̤a̤m̤p̤>>): S̤t̤a̤m̤p̤;
133-
initializers(functions: Array<stampit.Initializer<Obj, S̤t̤a̤m̤p̤>>): S̤t̤a̤m̤p̤;
132+
initializers(...functions: Array<stampit.Initializer<Obj, S>>): S;
133+
initializers(functions: Array<stampit.Initializer<Obj, S>>): S;
134134

135135
/**
136136
* Take in a variable number of functions and add them to the initializers prototype as initializers. **Chainable**.
137137
* @param functions Initializer functions used to create private data and privileged methods.
138138
*/
139-
init(...functions: Array<stampit.Initializer<Obj, S̤t̤a̤m̤p̤>>): S̤t̤a̤m̤p̤;
140-
init(functions: Array<stampit.Initializer<Obj, S̤t̤a̤m̤p̤>>): S̤t̤a̤m̤p̤;
139+
init(...functions: Array<stampit.Initializer<Obj, S>>): S;
140+
init(functions: Array<stampit.Initializer<Obj, S>>): S;
141141

142142
/**
143143
* Take n objects and add them to a new stamp and any future stamp it composes with. Creates and returns new Stamp. **Chainable**.
144144
* @param statics Object(s) containing map of property names and values to mixin into each new stamp.
145145
*/
146-
staticProperties(...statics: PropertyMap[]): S̤t̤a̤m̤p̤;
146+
staticProperties(...statics: PropertyMap[]): S;
147147

148148
/**
149149
* Take n objects and add them to a new stamp and any future stamp it composes with. Creates and returns new Stamp. **Chainable**.
150150
* @param statics Object(s) containing map of property names and values to mixin into each new stamp.
151151
*/
152-
statics(...statics: PropertyMap[]): S̤t̤a̤m̤p̤;
152+
statics(...statics: PropertyMap[]): S;
153153

154154
/**
155155
* Deeply merge a variable number of objects and add them to a new stamp and any future stamp it composes. Creates and returns a new Stamp. **Chainable**.
156156
* @param deepStatics The object(s) containing static properties to be merged.
157157
*/
158-
staticDeepProperties(...deepStatics: PropertyMap[]): S̤t̤a̤m̤p̤;
158+
staticDeepProperties(...deepStatics: PropertyMap[]): S;
159159

160160
/**
161161
* Deeply merge a variable number of objects and add them to a new stamp and any future stamp it composes. Creates and returns a new Stamp. **Chainable**.
162162
* @param deepStatics The object(s) containing static properties to be merged.
163163
*/
164-
deepStatics(...deepStatics: PropertyMap[]): S̤t̤a̤m̤p̤;
164+
deepStatics(...deepStatics: PropertyMap[]): S;
165165

166166
/**
167167
* Take in a variable number of functions and add them to the composers prototype as composers. **Chainable**.
168168
* @param functions Composer functions that will run in sequence while creating a new stamp from a list of composables. The resulting stamp and the composables get passed to composers.
169169
*/
170-
composers(...functions: Array<stampit.Composer<S̤t̤a̤m̤p̤>>): S̤t̤a̤m̤p̤;
171-
composers(functions: Array<stampit.Composer<S̤t̤a̤m̤p̤>>): S̤t̤a̤m̤p̤;
170+
composers(...functions: Array<stampit.Composer<S>>): S;
171+
composers(functions: Array<stampit.Composer<S>>): S;
172172

173173
/**
174174
* Shallowly assign properties of Stamp arbitrary metadata and add them to a new stamp and any future Stamp it composes. Creates and returns a new Stamp. **Chainable**.
175175
* @param confs The object(s) containing metadata properties.
176176
*/
177-
configuration(...confs: PropertyMap[]): S̤t̤a̤m̤p̤;
177+
configuration(...confs: PropertyMap[]): S;
178178

179179
/**
180180
* Shallowly assign properties of Stamp arbitrary metadata and add them to a new stamp and any future Stamp it composes. Creates and returns a new Stamp. **Chainable**.
181181
* @param confs The object(s) containing metadata properties.
182182
*/
183-
conf(...confs: PropertyMap[]): S̤t̤a̤m̤p̤;
183+
conf(...confs: PropertyMap[]): S;
184184

185185
/**
186186
* Deeply merge properties of Stamp arbitrary metadata and add them to a new Stamp and any future Stamp it composes. Creates and returns a new Stamp. **Chainable**.
187187
* @param deepConfs The object(s) containing metadata properties.
188188
*/
189-
deepConfiguration(...deepConfs: PropertyMap[]): S̤t̤a̤m̤p̤;
189+
deepConfiguration(...deepConfs: PropertyMap[]): S;
190190

191191
/**
192192
* Deeply merge properties of Stamp arbitrary metadata and add them to a new Stamp and any future Stamp it composes. Creates and returns a new Stamp. **Chainable**.
193193
* @param deepConfs The object(s) containing metadata properties.
194194
*/
195-
deepConf(...deepConfs: PropertyMap[]): S̤t̤a̤m̤p̤;
195+
deepConf(...deepConfs: PropertyMap[]): S;
196196

197197
/**
198198
* Apply ES5 property descriptors to object instances created by the new Stamp returned by the function and any future Stamp it composes. Creates and returns a new stamp. **Chainable**.
199199
* @param descriptors
200200
*/
201-
propertyDescriptors(...descriptors: PropertyDescriptorMap[]): S̤t̤a̤m̤p̤;
201+
propertyDescriptors(...descriptors: PropertyDescriptorMap[]): S;
202202

203203
/**
204204
* Apply ES5 property descriptors to a Stamp and any future Stamp it composes. Creates and returns a new stamp. **Chainable**.
205205
* @param descriptors
206206
*/
207-
staticPropertyDescriptors(...descriptors: PropertyDescriptorMap[]): S̤t̤a̤m̤p̤;
207+
staticPropertyDescriptors(...descriptors: PropertyDescriptorMap[]): S;
208208
}
209209

210210
/**
@@ -227,9 +227,9 @@ declare namespace stampit {
227227
/**
228228
* A `Stamp`'s metadata.
229229
* @template Obj The type of the object instance being produced by the `Stamp`.
230-
* @template S̤t̤a̤m̤p̤ The type of the `Stamp` (when extending a `Stamp`.)
230+
* @template S The type of the `Stamp` (when extending a `Stamp`.)
231231
*/
232-
interface Descriptor<Obj, S̤t̤a̤m̤p̤ extends StampSignature = Stamp<Obj>> {
232+
interface Descriptor<Obj, S extends StampSignature = Stamp<Obj>> {
233233
/** A set of methods that will be added to the object's delegate prototype. */
234234
methods?: MethodMap<Obj>;
235235
/** A set of properties that will be added to new object instances by assignment. */
@@ -245,9 +245,9 @@ declare namespace stampit {
245245
/** A set of object property descriptors (`PropertyDescriptor`) to apply to the `Stamp`. */
246246
staticPropertyDescriptors?: PropertyDescriptorMap;
247247
/** An array of functions that will run in sequence while creating an object instance from a `Stamp`. `Stamp` details and arguments get passed to initializers. */
248-
initializers?: Initializer<Obj, S̤t̤a̤m̤p̤> | Array<Initializer<Obj, S̤t̤a̤m̤p̤>>;
248+
initializers?: Initializer<Obj, S> | Array<Initializer<Obj, S>>;
249249
/** An array of functions that will run in sequence while creating a new `Stamp` from a list of `Composable`s. The resulting `Stamp` and the `Composable`s get passed to composers. */
250-
composers?: Array<Composer<S̤t̤a̤m̤p̤>>;
250+
composers?: Array<Composer<S>>;
251251
/** A set of options made available to the `Stamp` and its initializers during object instance creation. These will be copied by assignment. */
252252
configuration?: PropertyMap;
253253
/** A set of options made available to the `Stamp` and its initializers during object instance creation. These will be deep merged. */
@@ -257,9 +257,9 @@ declare namespace stampit {
257257
/**
258258
* A `stampit`'s metadata.
259259
* @template Obj The type of the object instance being produced by the `Stamp`.
260-
* @template S̤t̤a̤m̤p̤ The type of the `Stamp` (when extending a `Stamp`.)
260+
* @template S The type of the `Stamp` (when extending a `Stamp`.)
261261
*/
262-
interface ExtendedDescriptor<Obj, S̤t̤a̤m̤p̤ extends StampSignature = Stamp<Obj>> extends Descriptor<Obj, S̤t̤a̤m̤p̤> {
262+
interface ExtendedDescriptor<Obj, S extends StampSignature = Stamp<Obj>> extends Descriptor<Obj, S> {
263263
/** A set of properties that will be added to new object instances by assignment. */
264264
props?: PropertyMap;
265265
/** A set of properties that will be added to new object instances by deep property merge. */
@@ -269,12 +269,12 @@ declare namespace stampit {
269269
/** A set of static properties that will be added to the `Stamp` by deep property merge. */
270270
deepStatics?: PropertyMap;
271271
/** An array of functions that will run in sequence while creating an object instance from a `Stamp`. `Stamp` details and arguments get passed to initializers. */
272-
init?: Initializer<Obj, S̤t̤a̤m̤p̤> | Array<Initializer<Obj, S̤t̤a̤m̤p̤>>;
272+
init?: Initializer<Obj, S> | Array<Initializer<Obj, S>>;
273273
/** A set of options made available to the `Stamp` and its initializers during object instance creation. These will be copied by assignment. */
274274
conf?: PropertyMap;
275275
/** A set of options made available to the `Stamp` and its initializers during object instance creation. These will be deep merged. */
276276
deepConf?: PropertyMap;
277-
// TODO: Add description
277+
/** The `name` property of the `Stamp`. Will be assigned to `MyStamp.name`. */
278278
name?: string;
279279
}
280280

@@ -296,42 +296,42 @@ declare namespace stampit {
296296
/**
297297
* A function used as `.initializers` argument.
298298
* @template Obj The type of the object instance being produced by the `Stamp`.
299-
* @template S̤t̤a̤m̤p̤ The type of the `Stamp` producing the instance.
299+
* @template S The type of the `Stamp` producing the instance.
300300
*/
301-
interface Initializer<Obj, S̤t̤a̤m̤p̤ extends StampSignature> {
302-
(this: Obj, options: /*_propertyMap*/ any, context: InitializerContext<Obj, S̤t̤a̤m̤p̤>): void | Obj;
301+
interface Initializer<Obj, S extends StampSignature> {
302+
(this: Obj, options: /*_propertyMap*/ any, context: InitializerContext<Obj, S>): void | Obj;
303303
}
304304

305305
/**
306306
* The `Initializer` function context.
307307
* @template Obj The type of the object instance being produced by the `Stamp`.
308-
* @template S̤t̤a̤m̤p̤ The type of the `Stamp` producing the instance.
308+
* @template S The type of the `Stamp` producing the instance.
309309
*/
310-
interface InitializerContext<Obj, S̤t̤a̤m̤p̤ extends StampSignature> {
310+
interface InitializerContext<Obj, S extends StampSignature> {
311311
/** The object instance being produced by the `Stamp`. If the initializer returns a value other than `undefined`, it replaces the instance. */
312312
instance: Obj;
313313
/** A reference to the `Stamp` producing the instance. */
314-
stamp: S̤t̤a̤m̤p̤;
314+
stamp: S;
315315
/** An array of the arguments passed into the `Stamp`, including the options argument. */
316316
// ! above description from the specification is obscure
317317
args: any[];
318318
}
319319

320320
/**
321321
* A function used as `.composers` argument.
322-
* @template S̤t̤a̤m̤p̤ The type of the `Stamp` produced by the `.compose()` method.
322+
* @template S The type of the `Stamp` produced by the `.compose()` method.
323323
*/
324-
interface Composer<S̤t̤a̤m̤p̤ extends StampSignature> {
325-
(parameters: ComposerParameters<S̤t̤a̤m̤p̤>): void | S̤t̤a̤m̤p̤;
324+
interface Composer<S extends StampSignature> {
325+
(parameters: ComposerParameters<S>): void | S;
326326
}
327327

328328
/**
329329
* The parameters received by the current `.composers` function.
330-
* @template S̤t̤a̤m̤p̤ The type of the `Stamp` produced by the `.compose()` method.
330+
* @template S The type of the `Stamp` produced by the `.compose()` method.
331331
*/
332-
interface ComposerParameters<S̤t̤a̤m̤p̤ extends StampSignature> {
332+
interface ComposerParameters<S extends StampSignature> {
333333
/** The result of the `Composable`s composition. */
334-
stamp: S̤t̤a̤m̤p̤;
334+
stamp: S;
335335
/** The list of composables the `Stamp` was just composed of. */
336336
composables: Composable[];
337337
}
@@ -356,6 +356,5 @@ declare namespace stampit {
356356
/** A function which creates a new `Stamp`s from a list of `Composable`s. */
357357
const compose: ComposeMethod;
358358
}
359-
export const compose: typeof stampit.compose;
360359
// tslint:disable-next-line: npm-naming
361360
export default stampit;

0 commit comments

Comments
 (0)