symbols.js 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. // Licensed to the Software Freedom Conservancy (SFC) under one
  2. // or more contributor license agreements. See the NOTICE file
  3. // distributed with this work for additional information
  4. // regarding copyright ownership. The SFC licenses this file
  5. // to you under the Apache License, Version 2.0 (the
  6. // "License"); you may not use this file except in compliance
  7. // with the License. You may obtain a copy of the License at
  8. //
  9. // http://www.apache.org/licenses/LICENSE-2.0
  10. //
  11. // Unless required by applicable law or agreed to in writing,
  12. // software distributed under the License is distributed on an
  13. // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  14. // KIND, either express or implied. See the License for the
  15. // specific language governing permissions and limitations
  16. // under the License.
  17. 'use strict';
  18. /**
  19. * @fileoverview Defines well-known symbols used within the selenium-webdriver
  20. * library.
  21. */
  22. module.exports = {
  23. /**
  24. * The serialize symbol specifies a method that returns an object's serialized
  25. * representation. If an object's serialized form is not immediately
  26. * available, the serialize method will return a promise that will be resolved
  27. * with the serialized form.
  28. *
  29. * Note that the described method is analogous to objects that define a
  30. * `toJSON()` method, except the serialized result may be a promise, or
  31. * another object with a promised property.
  32. */
  33. serialize: Symbol('serialize')
  34. };