@@ -134,7 +134,6 @@ class AddressCapture extends Component {
134
134
_form = null ;
135
135
136
136
/**
137
- *
138
137
* @method hasAddressSuggestion
139
138
* @summary returns true if we have a suggested address from a address validation service
140
139
* @return {Boolean } - true if address suggestion on props
@@ -145,7 +144,6 @@ class AddressCapture extends Component {
145
144
}
146
145
147
146
/**
148
- *
149
147
* @method hasValidationError
150
148
* @summary returns true if we have any validation errors from a address validation service
151
149
* @return {Boolean } - true if validation errors on props
@@ -156,7 +154,6 @@ class AddressCapture extends Component {
156
154
}
157
155
158
156
/**
159
- *
160
157
* @method addressEntered
161
158
* @summary getter that returns the entered address
162
159
* @return {Object } addressEntered - Address object
@@ -167,7 +164,6 @@ class AddressCapture extends Component {
167
164
}
168
165
169
166
/**
170
- *
171
167
* @method addressSuggestion
172
168
* @summary getter that returns the suggested address
173
169
* @return {Object } addressSuggestion - Address object
@@ -178,7 +174,6 @@ class AddressCapture extends Component {
178
174
}
179
175
180
176
/**
181
- *
182
177
* @method addressProvided
183
178
* @summary getter that returns the provided address form value
184
179
* @return {Object } addressProvided - Address object
@@ -189,50 +184,46 @@ class AddressCapture extends Component {
189
184
}
190
185
191
186
/**
192
- *
193
187
* @method inEntry
194
188
* @summary getter that returns true if in entry mode
195
- * @return {Boolean }
189
+ * @return {Boolean } True if currently in entry status
196
190
*/
197
191
get inEntry ( ) {
198
192
const { status } = this . state ;
199
193
return status === ENTRY ;
200
194
}
201
195
202
196
/**
203
- *
204
197
* @method inEdit
205
198
* @summary getter that returns true if in edit mode
206
- * @return {Boolean }
199
+ * @return {Boolean } True if currently in edit status
207
200
*/
208
201
get inEdit ( ) {
209
202
const { status } = this . state ;
210
203
return status === EDIT ;
211
204
}
212
205
213
206
/**
214
- *
215
207
* @method inReview
216
208
* @summary getter that returns true if in review mode
217
- * @return {Boolean }
209
+ * @return {Boolean } True if currently in review status
218
210
*/
219
211
get inReview ( ) {
220
212
const { status } = this . state ;
221
213
return status === REVIEW ;
222
214
}
223
215
224
216
/**
225
- *
226
217
* @method toggleStatus
227
218
* @summary setter that toggles the Component's status.
219
+ * @param {String } status The new status
228
220
* @return {undefined }
229
221
*/
230
222
set toggleStatus ( status ) {
231
223
this . setState ( { status } ) ;
232
224
}
233
225
234
226
/**
235
- *
236
227
* @method formRef
237
228
* @summary binds the active form element to the `_form` property
238
229
* @param {Object } form - React ref element
@@ -243,8 +234,7 @@ class AddressCapture extends Component {
243
234
} ;
244
235
245
236
/**
246
- *
247
- * @name submit
237
+ * @method submit
248
238
* @summary Instance method that submits the form, this allows a parent component access to the Form submit event.
249
239
* @return {undefined }
250
240
*/
@@ -253,10 +243,9 @@ class AddressCapture extends Component {
253
243
} ;
254
244
255
245
/**
256
- *
257
246
* @method handleSubmit
258
247
* @summary validate or submit the entered address object.
259
- * @param {Object } address - submited address object
248
+ * @param {Object } address - submitted address object
260
249
* @return {undefined }
261
250
*/
262
251
handleSubmit = async ( address ) => {
0 commit comments